Summary of Document Interactions
The API exposes three FHIR interactions:
Document Search by PHN
FHIR Interaction: ?
HTTP Method: GET
URL: [base]/DocumentReference?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 DocumentReference 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 DocumentReference resources and/or an OperationOutcome. Each DocumentReference resource contains a document in a clinical data repository of a health authority (including the eHealth clinical data repository).
See a sample response
Document Search by ID
FHIR Interaction: _id
HTTP Method: GET
URL: [base]/DocumentReference?_id=[DocumentReference.id]
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| id | 1..1 | id | DocumentReference resource id |
Return Value (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| bundle | 1..1 | Bundle | A Bundle consists of a DocumentReference resource and/or an OperationOutcome. |
This transaction takes the resource id as the parameter and returns a DocumentReference and or OperationOutcome in a Bundle. The DocumentReference resource contains a document in a clinical data repository of a health authority (including the eHealth clinical data repository).
Document Read
FHIR Interaction: /
HTTP Method: GET
URL: [base]/DocumentReference/[DocumentReference.id]
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| [DocumentReference.id] | 1..1 | id | DocumentReference resource ID |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| DocumentReference | 0..1 | DocumentReference | DocumentReference 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: DocumentReference containing a single document in a clinical data repository, or an OperationOutcome containing errors or warnings from the interaction.