Patient Portal Status

The Patient Portal Status extension allows external systems to manage a patient's Patient Portal preference through the FHIR API. This extension can be included when creating or updating a Patient resource to indicate whether the patient has opted in to or opted out of the AdvaPACS Patient Portal.

The extension is optional. If provided, AdvaPACS updates the patient's portal status accordingly.

Canonical URL

Property	Value
Extension URL	http://advapacs.com/fhir/patient-portal-status
Value Type	boolean

Supported Resources

The extension is supported on the following FHIR resource:

FHIR Resource	Field	Description
Patient	extension	Specifies whether the patient has opted in to the Patient Portal.

Supported Operations

The Patient Portal Status extension is supported by the following FHIR operations:

Operation	Description
Create Patient	Sets the patient's portal status when creating a new Patient resource.
Update Patient	Updates the patient's portal status when modifying an existing Patient resource.

Extension Definition

Property	Description
URL	http://advapacs.com/fhir/patient-portal-status
Value Type	valueBoolean
true	The patient has opted in to the Patient Portal.
false	The patient has opted out of the Patient Portal.

Behaviour

When AdvaPACS receives a Patient resource containing the Patient Portal Status extension:

• A value of true records the patient as opted in to the Patient Portal.
• A value of false records the patient as opted out of the Patient Portal.
• If the extension is omitted, the patient's existing portal status is unchanged unless otherwise determined by local system configuration.

Example

The following example enables Patient Portal access for a patient by including the extension on the Patient resource.

{
  "resourceType": "Patient",
  "extension": [
    {
      "url": "http://advapacs.com/fhir/patient-portal-status",
      "valueBoolean": true
    }
  ]
}

note

The Patient Portal Status extension controls only the patient's portal preference within AdvaPACS. It does not create, activate, or manage a Patient Portal account.