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]

WriteUpdate

Sharing

/v1/consents/forPatient/[patientId]

Delete

Entity: Consent

Public ID

String

An ID for this Consent Record.

Consent.id

Aggregated ID

String

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

Legacy ID

String

An ID for this Consent Record.

General Health Granted

Boolean

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

Consent.except

Sharing

Mental Health Granted

Boolean

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

Consent.except

Sharing

Sexual Health Granted

Boolean

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

Consent.except

Sharing

Social Care Granted

Boolean

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

Consent.except

Sharing

Reason Code

Enum

• MIGRATED

• CREATED_ACCOUNT

• REFERRAL

• POWER_OF_ATTORNEY

• COURT_ORDER

• EXPLICIT_CONSENT

• DISCHARGE

• SAFEGUARDING

• PATIENT_OPT_OUT

Reason Text

String

A description justifying why these consent values were set.

Discharged

Boolean

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

Consent.status

Sharing

Professional Edit Only

Boolean

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

Sharing

Added

Timestamp

When the Consent Record was first recorded.

Updated

Timestamp

When the Consent Record was last updated.

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

Facade (STU3)

Aggregated (R4)

Summary of interactions

Create

Read

WriteUpdate

Delete

Entity: Patient Opt Out Record

Public ID

String

An ID for this Consent Record.

Aggregated ID

String

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

Sharing Enabled

Boolean

Indicates whether or not the patient has enabled sharing. If the patient has not opted out then a Patient Opt Out Record might not exist. A patient who has opted out might change their mind and choose to opt in again.