Measurements and simple assertions made about a patient, device or other subject.
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop the APIs. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis.
Warning: This site is provided for information only and is intended for those engaged with NHS Digital on the development of the APIs. It is advised not to develop against these specifications until a formal announcement has been made.
0. References
Profile: Observation |
HL7 FHIR STU3 Resource: Observation |
User Stories: N/A |
1. Read
GET the average, min, max and count of a series of BP measurements for a patient (Request):
GET [base]/Observation/$stats?subject=Patient/123&code=55284-4&system=http://loinc.org&duration=1&statistic=average&statistic=min&statistic=max&statistic=count
2. Search
GET [baseUrl]/Observation?[searchParameters]
All requests SHALL contain a valid ‘Authorization’ header and SHALL contain an ‘Accept’ header. The `Accept` header indicates the format of the response the client is able to understand, this will be one of the following application/json+fhir or application/xml+fhir.
2.1. Search Parameters
This implementation guide outlines some suggested search parameters for the Observation resource in the table below. To be conformant, provider systems are required to implement all of the SHALL parameters. Provider systems may implement the full list of search parameters for the Observation resource (HL7 FHIR STU3 Observation).
Note: Details on the Search Parameters selection and feedback process can be found here Search Parameters
3. Example
3.1 Http Body
<?xml version="1.0" encoding="UTF-8"?>
<Observation xmlns="http://hl7.org/fhir">
<id value="76e39290-d1aa-11e6-9598-1234567c9a66"/>
<meta>
<profile value="https://fhir.nhs.uk/StructureDefinition/CareConnect-Prescription-Observation-1"/>
</meta>
<status value="final"/>
<code>
<coding>
<system value="https://fhir.nhs.uk/STU3/ValueSet/Fhir-Observation-Code-1"/>
<code value="0002"/>
<display value="Prescription Exemption status observation"/>
</coding>
</code>
<subject>
<reference value="Patient/9900005896"/>
<display value="BRIDGE, Joanne (Mrs)"/>
</subject>
<effectiveDateTime value="2018-12-31T00:00:00+00:00"/>
<value>
<code>
<coding>
<system value="https://fhir.nhs.uk/STU3/ValueSet/Prescription-Exemption-Type-1"/>
<code value="9999"/>
<display value="Not able to confirm exemption from source"/>
</coding>
</code>
</value>
</Observation>