Summary of Alert Interactions
The API exposes three FHIR interactions:
Alert Search by PHN
FHIR Interaction: ?
HTTP Method: GET
URL: [base]/Flag?Patient=[BC PHN]
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| Patient | 1..1 | id | Patient's BC PHN |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| bundle | 1..1 | Bundle | A Bundle consists of a list of Flag resources and/or an OperationOutcome. |
This transaction performs the FHIR search interaction using the patient's BC PHN. The query response is a Bundle containing one or more Flag resources and/or an OperationOutcome. Each Flag resource contains patient alert details in the eHealth clinical data repository.
An example of read request and responses:
[base]/Flag?Patient=9698656164
Alert Search by ID
FHIR Interaction: _id
HTTP Method: GET
URL: [base]/Flag?_id=[Flag.id]
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| id | 1..1 | id | Flag resource id |
Return Value (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| bundle | 1..1 | Bundle | A Bundle consists of a Flag resource and/or an OperationOutcome. |
This transaction takes the resource id as the parameter and returns a Flag and or OperationOutcome in a Bundle. The Flag resource contains details of the patient alert in the eHealth clinical data repository.
An example of search request and responses:
[base]/Flag?_id=cdr.9698656164.inf.1915.2
Alert Read
FHIR Interaction: /
HTTP Method: GET
URL: [base]/Flag/[Flag.id]
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| [Flag.id] | 1..1 | id | Flag resource ID |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| Flag | 0..1 | Flag | Flag resource |
| OperationOutcome | 0..1 | OperationOutcome | OperationOutcome |
This transaction performs the FHIR read interaction on the resource based on resource.id. The query response is one of the resources: Flag containing a single alert in the eHealth clinical data repository, or an OperationOutcome containing errors or warnings from the interaction.
An example of read request and responses:
[base]/Flag/cdr.9698656164.inf.1915.2