Coordinate resource implementation guidance
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® CDS API.
Coordinate: Implementation Guidance
Usage
Within the Clinical Decision Support API implementation, the Coordinate resource is a Custom Resource Structure for the CDS API. It is used to carry details of answers to image-map question types within the QuestionnaireResponse.item.answer.value field during an $evaluate request.
The table below gives implementation guidance in relation to the elements within a Coordinate:
| Name | Cardinality | Type | FHIR Documentation | CDS Implementation Guidance |
|---|---|---|---|---|
id |
0..1 |
id | Logical id of this artifact | Note that this will always be populated except when the resource is being created (initial creation call) |
meta |
0..1 |
Meta | Metadata about the resource | |
implicitRules |
0..1 |
uri | A set of rules under which this content was created | |
language |
0..1 |
code | Language of the resource content. Common Languages (Extensible but limited to All Languages) |
|
text |
0..1 |
Narrative | Text summary of the resource, for human interpretation | |
contained |
0..* |
Resource | Contained, inline Resources | This SHOULD NOT be populated. |
extension |
0..* |
Extension | Additional Content defined by implementations | |
modifierExtension |
0..* |
Extension | Extensions that cannot be ignored | |
xCoordinate |
1..1 |
int | X-axis value of this co-ordinate | This is populated with a count of pixels from the origin (left) of the image as a rectangle - scaled to the original size of the image. |
yCoordinate |
1..1 |
int | Y-axis value of this co-ordinate | This is populated with a count of pixels from the origin (top) of the image as a rectangle - scaled to the original size of the image |
zCoordinate |
0..1 |
int | Z-axis value of this co-ordinate | This is populated with a count of pixels from the origin (closest) of the image as a rectangle - scaled to the original size of the image |
imageUri |
0..1 |
uri | The image for which the coordinates relate. | This SHOULD be populated. Where populated this MUST match the image link within Questionnaire.item.text. |
