Summary of Imaging Interactions
The API exposes three FHIR interactions:
Imaging Search by PHN
FHIR Interaction: ?
HTTP Method: GET
URL: [base]/DiagnosticReport?patient=[BC PHN]&category=IMG
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 DiagnosticReport 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 DiagnosticReport resources and/or an OperationOutcome. Each DiagnosticReport resource contains an imaging exam in a clinical data repository of a health authority.
See a sample response
Imaging Search by ID
FHIR Interaction: _id
HTTP Method: GET
URL: [base]/DiagnosticReport?_id=[DiagnosticReport.id]
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| id | 1..1 | id | DiagnosticReport resource id |
Return Value (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| bundle | 1..1 | Bundle | A Bundle consists of a DiagnosticReport resource and/or an OperationOutcome. |
This transaction takes the resource id as the parameter and returns a DiagnosticReport and or OperationOutcome in a Bundle. The DiagnosticReport resource contains an imaging exam in a clinical data repository of a health authority.
An example of search request and responses:
[base]/DiagnosticReport?_id=pdiv-iha.9698656164.1f59abc7-84e5-ef11-b732-0050568aef6a
Imaging Read
FHIR Interaction: /
HTTP Method: GET
URL: [base]/DiagnosticReport/[DiagnosticReport.id]
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| [DiagnosticReport.id] | 1..1 | id | DiagnosticReport resource ID |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| DiagnosticReport | 0..1 | DiagnosticReport | DiagnosticReport 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: DiagnosticReport containing a single imaging exam in a clinical data repository, or an OperationOutcome containing errors or warnings from the interaction.
An example of read request and responses:
[base]/DiagnosticReport/pdiv-iha.9698656164.1f59abc7-84e5-ef11-b732-0050568aef6a