SHR Service APIs

Schemas

Payload that initiates a Shared Health Record consent request against the DHA Consent Management Platform.

cr_id

string · required

Client Registry (CR) identifier of the patient whose records the consent covers.

Example: CR99551207471367-7

facility_id

string · required

Facility Registry (FR) code of the facility requesting consent.

Example: FID-47-115307-8

requested_by

string · required

Name or role of the person requesting consent. Recorded on the consent audit trail.

Example: Registration Clerk

visit_type

string · enum · required

Type of visit the consent is being requested for. OP for outpatient, IP for inpatient.

Enum values:

Example: IP

Result of creating a consent request. DHA dispatches an OTP to the patient and returns the consent id used by the verify, status and resend-otp calls.

consent_id

string

Identifier of the consent request. Supply it on the verify, status and resend-otp calls.

Example: VCR-20260624-13698E26

consent_status

string

Current state of the consent request as reported by DHA, for example Pending while the patient has not yet entered the OTP.

Example: Pending

message

string

Human readable outcome message from DHA.

Example: Consent request created successfully

otp_record

string

OTP record reference. Send it back with the OTP when verifying the consent.

Example: d67p9lhxxx

status

string

Outcome status reported by DHA.

Example: success

visit_type

string · enum

Type of visit the consent was requested for.

Enum values:

Example: IP

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.ErrorResponse

Standard error response format for all error conditions.

error

string

HTTP status text from the standard HTTP status codes.

Example: Bad Request

message

string

Detailed error message explaining what went wrong.

Example: consent_id path parameter is required

Payload that verifies a pending consent request with the one-time password the patient received.

otp

string · required

One-time password the patient received from DHA.

Example: 14384

otp_record

string · required

OTP record reference returned by the consent request. It ties the OTP back to the consent it was issued for.

Example: d67p9lhxxx

Result of verifying consent with an OTP. It carries the consent token used to read patient records and the visit the consent opened.

consent_token

string

Per-visit consent token. Send it in the X-Consent-Token header when fetching patient records.

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9

message

string

Human readable outcome message from DHA.

Example: Consent verified successfully

status

string

Outcome status reported by DHA.

Example: success

visit_id

string

Identifier of the visit opened by the verified consent. Use it to refresh consent or to close the visit.

Example: f5c2fd92-1847-407f-97b7-a9d277699c22

Current status of a consent request. Once the patient has approved, the response also carries the visit id opened for the consent.

consent_id

string

Identifier of the consent request being polled.

Example: VCR-20260624-13698E26

consent_status

string

Current state of the consent request as reported by DHA, for example Pending or Approved.

Example: Approved

message

string

Human readable outcome message from DHA.

Example: Consent status retrieved successfully

status

string

Outcome status reported by DHA.

Example: success

visit_id

string

Identifier of the visit opened against the approved consent. Use it to refresh consent or to close the visit.

Example: f5c2fd92-1847-407f-97b7-a9d277699c22

internal_domain_shr.ResendOTPResponse

Result of asking DHA to resend the consent OTP. It echoes the consent the OTP belongs to and carries a fresh OTP record reference.

consent_id

string

Identifier of the consent request the OTP was resent for.

Example: VCR-20260624-13698E26

consent_status

string

Current state of the consent request as reported by DHA.

Example: Pending

message

string

Human readable outcome message from DHA.

Example: OTP resent successfully

otp_record

string

OTP record reference for the newly issued OTP. Use this value, not the earlier one, when verifying the consent.

Example: d67p9lhxxx

status

string

Outcome status reported by DHA.

Example: success

visit_type

string · enum

Type of visit the consent was requested for.

Enum values:

Example: IP

Result of refreshing patient consent for an open visit. It carries a fresh consent token for reading patient records.

consent_token

string

Refreshed per-visit consent token. Replace the token you were using and send this one in the X-Consent-Token header.

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9

message

string

Human readable outcome message from DHA.

Example: Patient consent refreshed successfully

status

string

Outcome status reported by DHA.

Example: success

internal_domain_shr.CloseVisitResponse

Result of closing an SHR visit. Once closed, the visit's consent token can no longer be refreshed.

consent_id

string

Identifier of the consent request the closed visit belonged to.

Example: VCR-20260624-13698E26

end_date

string

Timestamp at which the visit was closed.

Example: 2026-06-24T14:32:11Z

message

string

Human readable outcome message from DHA.

Example: Visit closed successfully

status

string

Outcome status reported by DHA.

Example: success

visit_id

string

Identifier of the visit that was closed.

Example: f5c2fd92-1847-407f-97b7-a9d277699c22

internal_domain_shr.SubmitBundleResponse

Result of submitting a FHIR bundle to the Shared Health Record.

mediator_id

string

Identifier DHA assigned to the submitted bundle. Quote it when following up on a submission.

Example: b3f0a3f6-2c1e-4a41-9f0a-3f6c1e4a419f

message

string

Human readable outcome message from DHA.

Example: Bundle submitted successfully

status

string

Outcome status reported by DHA.

Example: success

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.ConsentRequestInput

Payload that initiates a Shared Health Record consent request against the DHA Consent Management Platform.

cr_id

string · required

Client Registry (CR) identifier of the patient whose records the consent covers.

Example: CR99551207471367-7

facility_id

string · required

Facility Registry (FR) code of the facility requesting consent.

Example: FID-47-115307-8

requested_by

string · required

Name or role of the person requesting consent. Recorded on the consent audit trail.

Example: Registration Clerk

visit_type

string · enum · required

Type of visit the consent is being requested for. OP for outpatient, IP for inpatient.

Enum values:

Example: IP

internal_domain_shr.ConsentRequestResponse

Result of creating a consent request. DHA dispatches an OTP to the patient and returns the consent id used by the verify, status and resend-otp calls.

consent_id

string

Identifier of the consent request. Supply it on the verify, status and resend-otp calls.

Example: VCR-20260624-13698E26

consent_status

string

Current state of the consent request as reported by DHA, for example Pending while the patient has not yet entered the OTP.

Example: Pending

message

string

Human readable outcome message from DHA.

Example: Consent request created successfully

otp_record

string

OTP record reference. Send it back with the OTP when verifying the consent.

Example: d67p9lhxxx

status

string

Outcome status reported by DHA.

Example: success

visit_type

string · enum

Type of visit the consent was requested for.

Enum values:

Example: IP

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.ConsentVerifyInput

Payload that verifies a pending consent request with the one-time password the patient received.

otp

string · required

One-time password the patient received from DHA.

Example: 14384

otp_record

string · required

OTP record reference returned by the consent request. It ties the OTP back to the consent it was issued for.

Example: d67p9lhxxx

internal_domain_shr.VerifyConsentResponse

Result of verifying consent with an OTP. It carries the consent token used to read patient records and the visit the consent opened.

consent_token

string

Per-visit consent token. Send it in the X-Consent-Token header when fetching patient records.

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9

message

string

Human readable outcome message from DHA.

Example: Consent verified successfully

status

string

Outcome status reported by DHA.

Example: success

visit_id

string

Identifier of the visit opened by the verified consent. Use it to refresh consent or to close the visit.

Example: f5c2fd92-1847-407f-97b7-a9d277699c22

internal_domain_shr.ConsentStatusResponse

Current status of a consent request. Once the patient has approved, the response also carries the visit id opened for the consent.

consent_id

string

Identifier of the consent request being polled.

Example: VCR-20260624-13698E26

consent_status

string

Current state of the consent request as reported by DHA, for example Pending or Approved.

Example: Approved

message

string

Human readable outcome message from DHA.

Example: Consent status retrieved successfully

status

string

Outcome status reported by DHA.

Example: success

visit_id

string

Identifier of the visit opened against the approved consent. Use it to refresh consent or to close the visit.

Example: f5c2fd92-1847-407f-97b7-a9d277699c22

internal_domain_shr.ResendOTPResponse

Result of asking DHA to resend the consent OTP. It echoes the consent the OTP belongs to and carries a fresh OTP record reference.

consent_id

string

Identifier of the consent request the OTP was resent for.

Example: VCR-20260624-13698E26

consent_status

string

Current state of the consent request as reported by DHA.

Example: Pending

message

string

Human readable outcome message from DHA.

Example: OTP resent successfully

otp_record

string

OTP record reference for the newly issued OTP. Use this value, not the earlier one, when verifying the consent.

Example: d67p9lhxxx

status

string

Outcome status reported by DHA.

Example: success

visit_type

string · enum

Type of visit the consent was requested for.

Enum values:

Example: IP

internal_domain_shr.RefreshConsentResponse

Result of refreshing patient consent for an open visit. It carries a fresh consent token for reading patient records.

consent_token

string

Refreshed per-visit consent token. Replace the token you were using and send this one in the X-Consent-Token header.

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9

message

string

Human readable outcome message from DHA.

Example: Patient consent refreshed successfully

status

string

Outcome status reported by DHA.

Example: success

internal_domain_shr.CloseVisitResponse

Result of closing an SHR visit. Once closed, the visit's consent token can no longer be refreshed.

consent_id

string

Identifier of the consent request the closed visit belonged to.

Example: VCR-20260624-13698E26

end_date

string

Timestamp at which the visit was closed.

Example: 2026-06-24T14:32:11Z

message

string

Human readable outcome message from DHA.

Example: Visit closed successfully

status

string

Outcome status reported by DHA.

Example: success

visit_id

string

Identifier of the visit that was closed.

Example: f5c2fd92-1847-407f-97b7-a9d277699c22

internal_domain_shr.SubmitBundleResponse

Result of submitting a FHIR bundle to the Shared Health Record.

mediator_id

string

Identifier DHA assigned to the submitted bundle. Quote it when following up on a submission.

Example: b3f0a3f6-2c1e-4a41-9f0a-3f6c1e4a419f

message

string

Human readable outcome message from DHA.

Example: Bundle submitted successfully

status

string

Outcome status reported by DHA.

Example: success