Page Comparison

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

Facade (STU3)

Aggregated (R4)

Summary of interactions

Create

Sharing

/v1/consents/forPatient/[patientId]

Read

/Consent

Sharing

/v1/consents/byPatient/[patientId]

Update

Sharing

/v1/consents/forPatient/[patientId]

Delete

Entity: Consent

Public ID String

An ID for this Consent Record.

Consent.id

Not shown.

Aggregated ID String

Consent Records that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated.

Not shown.

Legacy ID String

An ID for this Consent Record.

Not shown.

id

General Health Granted Boolean

Whether or not the patient has granted access to the general health portion of their medical record.

Consent.except

Shown.

 generalHealthConsentGranted

Mental Health Granted Boolean

Whether or not the patient has granted access to the mental health portion of their medical record.

Consent.except

Shown.

 mentalHealthConsentGranted

Sexual Health Granted Boolean

Whether or not the patient has granted access to the sexual health portion of their medical record.

Consent.except

Shown.

 sexualHealthConsentGranted

Social Care Granted Boolean

Whether or not the patient has granted access to the social care portion of their medical record.

Consent.except

Shown.

 socialCareConsentGranted

Reason Code Enum

• MIGRATED

• CREATED_ACCOUNT

• REFERRAL

• POWER_OF_ATTORNEY

• COURT_ORDER

• EXPLICIT_CONSENT

• DISCHARGE

• SAFEGUARDING

• PATIENT_OPT_OUT

• EXPIRED

Patients are not required to provide a reason.

Once provided, the value is not shown.

generalHealthConsentGrantedReason

mentalHealthConsentGrantedReason

sexualHealthConsentGrantedReason

socialCareConsentGrantedReason

Reason Text String

A description justifying why these consent values were set.

Patients are not required to provide a reason.

Once provided, the value is not shown.

 generalHealthConsentGrantedReasonText

mentalHealthConsentGrantedReasonText

sexualHealthConsentGrantedReasonText

socialCareConsentGrantedReasonText

Discharged Boolean

Indicates whether the actor is currently providing care to the patient.

Consent.status

When true, the relevant entries are shown in the Past sharing section.

A patient can “discharge” themselves from individual professionals or carers, but only a professional can discharge a patient from a team.

Professional Edit Only Boolean

Indicates whether this Consent Record has been locked. See the manual on Paediatric Records for more information.

Shown.

Added Timestamp

When the Consent Record was first recorded.

Not shown.

Updated Timestamp

When the Consent Record was last updated.

Not shown.