Status: DRAFT: For Review

Introduction

This profile sets out the expectations for the interweave breathing air observation resource. UK Core does not have a profile for this observation, and therefore the base for this profile is Interweave-Observation.

We stipulate the use of SNOMED concept codes where possible, and the result should be provided as a true/false value within the valueBoolean field.

Mandatory fields

The following mandatory fields are defined:

1. status – Fixed value of ‘final’. Only finalised observations should be shared.

2. category – Fixed value of ‘vital-signs’.

3. code – Fixed value of SCT: 722742002 (Breathing room air).

4. subject – Reference to the patient who is the subject of this measurement.

5. effective – An important field to provide details of the time/time period during which the observation was taken.

6. valueBoolean – true if the patient is observed breathing room air, otherwise false.

Must Support fields

In addition the following fields are "Must Support" - ie they must be populated if relevant and known.

1. identifier – A Local Id should be provided, such that could be quoted if manually getting in touch to find out more.

2. encounter – his will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). For some observations it may be important to know the link between an observation and a particular encounter.

3. performer – We limit this field to reference practitioner / practitionerRole/ CareTeam resources only. The organization responsible for the observation can be obtained via the provenance tag.

4. note – Comments in addition to the result are often recorded for observations, it is therefore important to provide this field when available to give the consumer the full result information.

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Points of note include:

• method – Option to provide the mechanism used to perform the observation

• device – Opportunity to provide a link to a device resource from which was used to obtain the observation.

Discouraged or Removed fields

• Component – Removed to aid the data consumer, we ask that the result is provided in the valueQuantity field and not as a component.

• basedOn – This field is discouraged as it does not appear to provide information which would be beneficial in a shared care record. It also allows references to a raft of request/order resources which introduces a lot of complexity for a data consumer.

• partOf – This field is discouraged as it does not appear to provide information which would be beneficial in a shared care record. It also allows references to a raft of request/order resources which introduces a lot of complexity for a data consumer.

• issued – This field has been removed as this information can be taken from the mandatory meta.lastUpdated field, and to also avoid any confusion with the other date fields.

• dataAbsentReason - Removed.
• specimen – Removed.
• bodysite - Removed.
• Interpretation - Removed.
• ReferenceRange - Removed.
• DerivedFrom - Removed.
• focus - Removed.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from InterweaveObservation

Name	Flags	Card.	Type	Description & Constraints
Observation		0..*	InterweaveObservation	Measurements and simple assertions
Slices for extension				Content/Rules for all slices
extension:bodyStructureR5		0..0
status		1..1	code	Fixed value of ‘final’. Fixed Value: final
Slices for category				Content/Rules for all slices
category:observationCategory		1..1	CodeableConcept	A code that classifies the general type of observation being made.
coding
code		1..1	code	Symbol in syntax defined by the system Fixed Value: vital-signs
display		1..1	string	Representation defined by the system Fixed Value: Vital Signs
code
coding
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 722742002
display		1..1	string	Representation defined by the system Fixed Value: Breathing room air
effective[x]		1..1		This is the time/time period during which the observation was taken.
effectiveDateTime			dateTime
effectiveInstant			instant
value[x]		1..1	boolean	Actual result.
dataAbsentReason		0..0
interpretation		0..0
bodySite		0..0
specimen		0..0
referenceRange		0..0
derivedFrom		0..0
component		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	InterweaveObservation	Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
Slices for extension				Content/Rules for all slices
valuePrecision		0..1	integer	Explicit precision of the number URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ValuePrecision
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business Identifier for observation
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
status	?!SΣ	1..1	code	Fixed value of ‘final’. Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final
Slices for category	S	1..*	CodeableConcept	A code that classifies the general type of observation being made. Slice: Unordered, Open by value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:observationCategory	S	1..1	CodeableConcept	A code that classifies the general type of observation being made. Binding: ObservationCategoryCodes (required): Codes for high level observation categories.
extension		0..0
code	SΣ	1..1	CodeableConcept	The type of observation (code / type). Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation
extension		0..0
subject	SΣ	1..1	Reference(InterweavePatient)	Who and / or what the observation is about.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
display	Σ	1..1	string	Description of the referenced resource
encounter	SΣ	0..1	Reference(InterweaveEncounter)	Healthcare event during which this observation is made
effective[x]	SΣ	1..1		This is the time/time period during which the observation was taken.
effectiveDateTime			dateTime
effectiveInstant			instant
performer	SΣ	0..*	Reference(Practitioner | PractitionerRole | CareTeam)	Who is responsible for the observation.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
display	Σ	1..1	string	Description of the referenced resource
value[x]	SΣC	1..1	boolean	Actual result.
note	S	0..1	Annotation	Comments about the observation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.extension:triggeredByR5.extension:type.value[x]	required	http://hl7.org/fhir/ValueSet/observation-triggeredbytype http://hl7.org/fhir/ValueSet/observation-triggeredbytype
Observation.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Observation.status	required	Fixed Value: final http://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard
Observation.category:observationCategory	required	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard
Observation.code	preferred	UKCoreObservationType https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType from this IG
Observation.component.code	preferred	UKCoreObservationType https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType from this IG
Observation.component.dataAbsentReason	required	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Observation.component.interpretation	required	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Observation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	InterweaveObservation	Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
valuePrecision		0..1	integer	Explicit precision of the number URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ValuePrecision
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business Identifier for observation
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
basedOn	Σ	0..*	Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)	DISCOURAGED - This field does not appear to provide information which would be beneficial in a shared care record. It also allows references to a raft of request/order resources which introduces a lot of complexity for a data consumer.
partOf	Σ	0..*	Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)	DISCOURAGED - This field does not appear to provide information which would be beneficial in a shared care record. It also allows references to a raft of request/order resources which introduces a lot of complexity for a data consumer.
status	?!SΣ	1..1	code	Fixed value of ‘final’. Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final
Slices for category	S	1..*	CodeableConcept	A code that classifies the general type of observation being made. Slice: Unordered, Open by value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:observationCategory	S	1..1	CodeableConcept	A code that classifies the general type of observation being made. Binding: ObservationCategoryCodes (required): Codes for high level observation categories.
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: vital-signs
display	Σ	1..1	string	Representation defined by the system Fixed Value: Vital Signs
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
code	SΣ	1..1	CodeableConcept	The type of observation (code / type). Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 722742002
display	Σ	1..1	string	Representation defined by the system Fixed Value: Breathing room air
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(InterweavePatient)	Who and / or what the observation is about.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
encounter	SΣ	0..1	Reference(InterweaveEncounter)	Healthcare event during which this observation is made
effective[x]	SΣ	1..1		This is the time/time period during which the observation was taken.
effectiveDateTime			dateTime
effectiveInstant			instant
performer	SΣ	0..*	Reference(Practitioner | PractitionerRole | CareTeam)	Who is responsible for the observation.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
value[x]	SΣC	1..1	boolean	Actual result.
note	S	0..1	Annotation	Comments about the observation
method		0..1	CodeableConcept	How it was done Binding: ObservationMethods (preferred): Methods for simple observations.
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
device		0..1	Reference(Device)	(Measurement) Device
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Observation.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Observation.extension:triggeredByR5.extension:type.value[x]	required	http://hl7.org/fhir/ValueSet/observation-triggeredbytype http://hl7.org/fhir/ValueSet/observation-triggeredbytype
Observation.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Observation.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Observation.status	required	Fixed Value: final http://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard
Observation.category:observationCategory	required	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard
Observation.code	preferred	UKCoreObservationType https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType from this IG
Observation.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Observation.performer.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Observation.method	preferred	ObservationMethods http://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard
Observation.referenceRange.type	preferred	ObservationReferenceRangeMeaningCodes http://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard
Observation.referenceRange.appliesTo	example	ObservationReferenceRangeAppliesToCodes http://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard
Observation.component.code	preferred	UKCoreObservationType https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType from this IG
Observation.component.dataAbsentReason	required	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Observation.component.interpretation	required	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Observation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

This structure is derived from InterweaveObservation

Name	Flags	Card.	Type	Description & Constraints
Observation		0..*	InterweaveObservation	Measurements and simple assertions
Slices for extension				Content/Rules for all slices
extension:bodyStructureR5		0..0
status		1..1	code	Fixed value of ‘final’. Fixed Value: final
Slices for category				Content/Rules for all slices
category:observationCategory		1..1	CodeableConcept	A code that classifies the general type of observation being made.
coding
code		1..1	code	Symbol in syntax defined by the system Fixed Value: vital-signs
display		1..1	string	Representation defined by the system Fixed Value: Vital Signs
code
coding
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 722742002
display		1..1	string	Representation defined by the system Fixed Value: Breathing room air
effective[x]		1..1		This is the time/time period during which the observation was taken.
effectiveDateTime			dateTime
effectiveInstant			instant
value[x]		1..1	boolean	Actual result.
dataAbsentReason		0..0
interpretation		0..0
bodySite		0..0
specimen		0..0
referenceRange		0..0
derivedFrom		0..0
component		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	InterweaveObservation	Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
Slices for extension				Content/Rules for all slices
valuePrecision		0..1	integer	Explicit precision of the number URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ValuePrecision
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business Identifier for observation
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
status	?!SΣ	1..1	code	Fixed value of ‘final’. Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final
Slices for category	S	1..*	CodeableConcept	A code that classifies the general type of observation being made. Slice: Unordered, Open by value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:observationCategory	S	1..1	CodeableConcept	A code that classifies the general type of observation being made. Binding: ObservationCategoryCodes (required): Codes for high level observation categories.
extension		0..0
code	SΣ	1..1	CodeableConcept	The type of observation (code / type). Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation
extension		0..0
subject	SΣ	1..1	Reference(InterweavePatient)	Who and / or what the observation is about.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
display	Σ	1..1	string	Description of the referenced resource
encounter	SΣ	0..1	Reference(InterweaveEncounter)	Healthcare event during which this observation is made
effective[x]	SΣ	1..1		This is the time/time period during which the observation was taken.
effectiveDateTime			dateTime
effectiveInstant			instant
performer	SΣ	0..*	Reference(Practitioner | PractitionerRole | CareTeam)	Who is responsible for the observation.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
display	Σ	1..1	string	Description of the referenced resource
value[x]	SΣC	1..1	boolean	Actual result.
note	S	0..1	Annotation	Comments about the observation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.extension:triggeredByR5.extension:type.value[x]	required	http://hl7.org/fhir/ValueSet/observation-triggeredbytype http://hl7.org/fhir/ValueSet/observation-triggeredbytype
Observation.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Observation.status	required	Fixed Value: final http://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard
Observation.category:observationCategory	required	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard
Observation.code	preferred	UKCoreObservationType https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType from this IG
Observation.component.code	preferred	UKCoreObservationType https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType from this IG
Observation.component.dataAbsentReason	required	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Observation.component.interpretation	required	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Observation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	InterweaveObservation	Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
valuePrecision		0..1	integer	Explicit precision of the number URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ValuePrecision
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business Identifier for observation
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
basedOn	Σ	0..*	Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)	DISCOURAGED - This field does not appear to provide information which would be beneficial in a shared care record. It also allows references to a raft of request/order resources which introduces a lot of complexity for a data consumer.
partOf	Σ	0..*	Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)	DISCOURAGED - This field does not appear to provide information which would be beneficial in a shared care record. It also allows references to a raft of request/order resources which introduces a lot of complexity for a data consumer.
status	?!SΣ	1..1	code	Fixed value of ‘final’. Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final
Slices for category	S	1..*	CodeableConcept	A code that classifies the general type of observation being made. Slice: Unordered, Open by value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:observationCategory	S	1..1	CodeableConcept	A code that classifies the general type of observation being made. Binding: ObservationCategoryCodes (required): Codes for high level observation categories.
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: vital-signs
display	Σ	1..1	string	Representation defined by the system Fixed Value: Vital Signs
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
code	SΣ	1..1	CodeableConcept	The type of observation (code / type). Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 722742002
display	Σ	1..1	string	Representation defined by the system Fixed Value: Breathing room air
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(InterweavePatient)	Who and / or what the observation is about.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
encounter	SΣ	0..1	Reference(InterweaveEncounter)	Healthcare event during which this observation is made
effective[x]	SΣ	1..1		This is the time/time period during which the observation was taken.
effectiveDateTime			dateTime
effectiveInstant			instant
performer	SΣ	0..*	Reference(Practitioner | PractitionerRole | CareTeam)	Who is responsible for the observation.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
value[x]	SΣC	1..1	boolean	Actual result.
note	S	0..1	Annotation	Comments about the observation
method		0..1	CodeableConcept	How it was done Binding: ObservationMethods (preferred): Methods for simple observations.
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
device		0..1	Reference(Device)	(Measurement) Device
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Observation.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Observation.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Observation.extension:triggeredByR5.extension:type.value[x]	required	http://hl7.org/fhir/ValueSet/observation-triggeredbytype http://hl7.org/fhir/ValueSet/observation-triggeredbytype
Observation.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Observation.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Observation.status	required	Fixed Value: final http://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard
Observation.category:observationCategory	required	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard
Observation.code	preferred	UKCoreObservationType https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType from this IG
Observation.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Observation.performer.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Observation.method	preferred	ObservationMethods http://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard
Observation.referenceRange.type	preferred	ObservationReferenceRangeMeaningCodes http://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard
Observation.referenceRange.appliesTo	example	ObservationReferenceRangeAppliesToCodes http://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard
Observation.component.code	preferred	UKCoreObservationType https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType from this IG
Observation.component.dataAbsentReason	required	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Observation.component.interpretation	required	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Observation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from InterweaveObservation

Summary

Mandatory: 1 element
Fixed: 6 elements
Prohibited: 8 elements