GP Chronic Condition Management Plan, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/gpccmp-fhir-ig/ and changes regularly. See the Directory of published versions
Resource Profile: GP CCMP Pulse Rate
| Official URL: https://gpccmp.csiro.au/ig/StructureDefinition/GPCCMPPulseRate | Version: 0.1.0 | |||
| Draft as of 2026-02-13 | Computable Name: GPCCMPPulseRate | |||
This profile sets the minimum expectations for a Pulse Rate resource to record and search pulse rate information when used within the GP Chronic Condition Management Plan.
Usages:
- CapabilityStatements using this Profile: GPCCMP Client Capability Statement and GPCCMP Server Capability Statement
- This Profile is not used by any profiles in this Implementation Guide
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
C | 0..* | AUCoreHeartRate | Heart rate Constraints: obs-6, obs-7, vs-2 | |||||||||||||||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||
| status |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required)
| |||||||||||||||||||||
  Slices for category |
SO | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
   category:VSCat |
SO | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
   coding |
SOΣ | 1..* | Coding | Code defined by a terminology system
| |||||||||||||||||||||
| system |
SOΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
| |||||||||||||||||||||
 code |
SOΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs
| |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Heart Rate Binding: VitalSigns (extensible): This identifies the vital sign result type.
| |||||||||||||||||||||
 Slices for coding |
Σ | 3..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | |||||||||||||||||||||
 coding:HeartRateCode |
Σ | 1..1 | Coding | Code defined by a terminology system | |||||||||||||||||||||
  system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||||||||||||||||
 code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8867-4 | |||||||||||||||||||||
| coding:snomedHeartRateCode |
Σ | 1..1 | Coding | SNOMED CT Heart Rate | |||||||||||||||||||||
| 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: 364075005 | |||||||||||||||||||||
| coding:snomedPulseRate |
SOΣ | 1..1 | Coding | Code defined by a terminology system
| |||||||||||||||||||||
| 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: 78564009 | |||||||||||||||||||||
 subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||||||||||||||||
| effective[x] |
SOΣC | 1..1 | dateTime | Date, and optionally time, the observation was performed Constraints: vs-1
| |||||||||||||||||||||
| Slices for value[x] |
SOΣC | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. Slice: Unordered, Closed by type:$this
| |||||||||||||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Heart rate
| |||||||||||||||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision)
| |||||||||||||||||||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||||||||||||||||||
| unit |
SOΣ | 1..1 | string | Unit representation
| |||||||||||||||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| |||||||||||||||||||||
| code |
SOΣ | 1..1 | code | Coded responses from the common UCUM units for vital signs value set. Fixed Value: /min
| |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| component |
SOΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. Constraints: vs-3
| |||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VitalSigns (extensible): This identifies the vital sign result type.
| |||||||||||||||||||||
 value[x] |
SOΣC | 0..1 | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
| ||||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||||||||||||
| valueString |
string | ||||||||||||||||||||||||
| valueBoolean |
boolean | ||||||||||||||||||||||||
| valueInteger |
integer | ||||||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||||||
| valueTime |
time | ||||||||||||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:VSCat | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.value[x]:valueQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x] | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| vs-1 | error | Observation.effective[x] | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
$this is dateTime implies $this.toString().length() >= 10
|
| vs-2 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present. |
(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
|
| vs-3 | error | Observation.component | If there is no a value a data absent reason must be present |
value.exists() or dataAbsentReason.exists()
|
This structure is derived from AUCoreHeartRate
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
0..* | AUCoreHeartRate | Heart rate | ||||||||||||||||
 status |
O | 1..1 | code | registered | preliminary | final | amended +
| |||||||||||||||
| code |
|||||||||||||||||||
| coding |
3..* | Coding | Code defined by a terminology system | ||||||||||||||||
| Slices for coding |
Content/Rules for all slices | ||||||||||||||||||
| coding:snomedPulseRate |
SO | 1..1 | Coding | Code defined by a terminology system
| |||||||||||||||
| 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: 78564009 | ||||||||||||||||
| subject |
O | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||||||||||
| effective[x] |
O | 1..1 | dateTime | Date, and optionally time, the observation was performed
| |||||||||||||||
| value[x] |
O | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
| |||||||||||||||
| Slices for value[x] |
Content/Rules for all slices | ||||||||||||||||||
| value[x]:valueQuantity |
O | 0..1 | Quantity | Heart rate
| |||||||||||||||
| value |
O | 1..1 | decimal | Numerical value (with implicit precision)
| |||||||||||||||
| system |
O | 1..1 | uri | System that defines coded unit form
| |||||||||||||||
| code |
O | 1..1 | code | Coded responses from the common UCUM units for vital signs value set.
| |||||||||||||||
| Documentation for this format | |||||||||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUCoreHeartRate | Heart rate Constraints: obs-6, obs-7, vs-2 | |||||||||||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||||||
| 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 Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | |||||||||||||||||||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||||||||||||||||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||||||||||||||||||
| status |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required)
| |||||||||||||||||||||
| Slices for category |
SO | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
| category:VSCat |
SO | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
 coding |
SOΣ | 1..* | Coding | Code defined by a terminology system
| |||||||||||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| system |
SOΣ | 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 |
SOΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs
| |||||||||||||||||||||
| display |
Σ | 0..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 | |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Heart Rate Binding: VitalSigns (extensible): This identifies the vital sign result type.
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| Slices for coding |
Σ | 3..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | |||||||||||||||||||||
| coding:HeartRateCode |
Σ | 1..1 | Coding | Code defined by a terminology system | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| 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: http://loinc.org | |||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8867-4 | |||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||
| coding:snomedHeartRateCode |
Σ | 1..1 | Coding | SNOMED CT Heart Rate | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| 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: 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: 364075005 | |||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||
| coding:snomedPulseRate |
SOΣ | 1..1 | Coding | Code defined by a terminology system
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| 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: 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: 78564009 | |||||||||||||||||||||
| display |
Σ | 0..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 | |||||||||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||||||||||||||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||||||||||||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||||||||||||||||||
| effective[x] |
SOΣC | 1..1 | dateTime | Date, and optionally time, the observation was performed Constraints: vs-1
| |||||||||||||||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | |||||||||||||||||||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |||||||||||||||||||||
| Slices for value[x] |
SOΣC | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. Slice: Unordered, Closed by type:$this
| |||||||||||||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Heart rate
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision)
| |||||||||||||||||||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||||||||||||||||||
| unit |
SOΣ | 1..1 | string | Unit representation
| |||||||||||||||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| |||||||||||||||||||||
| code |
SOΣ | 1..1 | code | Coded responses from the common UCUM units for vital signs value set. Fixed Value: /min
| |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||||||||||||
| note |
0..* | Annotation | Comments about the observation | ||||||||||||||||||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site  (preferred)Constraints: au-core-obs-01 | |||||||||||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | ||||||||||||||||||||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | ||||||||||||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | ||||||||||||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant | |||||||||||||||||||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant | |||||||||||||||||||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | ||||||||||||||||||||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | ||||||||||||||||||||||
| age |
0..1 | Range | Applicable age range, if relevant | ||||||||||||||||||||||
| text |
0..1 | string | Text based reference range in an observation | ||||||||||||||||||||||
| hasMember |
Σ | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components | |||||||||||||||||||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Related measurements the observation is made from | |||||||||||||||||||||
| component |
SOΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. Constraints: vs-3
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VitalSigns (extensible): This identifies the vital sign result type.
| |||||||||||||||||||||
| value[x] |
SOΣC | 0..1 | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
| ||||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||||||||||||
| valueString |
string | ||||||||||||||||||||||||
| valueBoolean |
boolean | ||||||||||||||||||||||||
| valueInteger |
integer | ||||||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||||||
| valueTime |
time | ||||||||||||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | ||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:VSCat | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.value[x]:valueQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.bodySite | Base | preferred |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| Observation.method | Base | example | Observation Methods | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x] | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | error | Observation.bodySite | If a coded body site is provided, at least one coding shall be from SNOMED CT |
coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
|
| 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-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.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()
|
| vs-1 | error | Observation.effective[x] | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
$this is dateTime implies $this.toString().length() >= 10
|
| vs-2 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present. |
(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
|
| vs-3 | error | Observation.component | If there is no a value a data absent reason must be present |
value.exists() or dataAbsentReason.exists()
|
This structure is derived from AUCoreHeartRate
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUCoreHeartRate | Heart rate Constraints: obs-6, obs-7, vs-2 | |||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||
| status |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required)
| |||||||||||||||||||||
| Slices for category |
SO | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
| category:VSCat |
SO | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
| coding |
SOΣ | 1..* | Coding | Code defined by a terminology system
| |||||||||||||||||||||
| system |
SOΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
| |||||||||||||||||||||
| code |
SOΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs
| |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Heart Rate Binding: VitalSigns (extensible): This identifies the vital sign result type.
| |||||||||||||||||||||
| Slices for coding |
Σ | 3..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | |||||||||||||||||||||
| coding:HeartRateCode |
Σ | 1..1 | Coding | Code defined by a terminology system | |||||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||||||||||||||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8867-4 | |||||||||||||||||||||
| coding:snomedHeartRateCode |
Σ | 1..1 | Coding | SNOMED CT Heart Rate | |||||||||||||||||||||
| 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: 364075005 | |||||||||||||||||||||
| coding:snomedPulseRate |
SOΣ | 1..1 | Coding | Code defined by a terminology system
| |||||||||||||||||||||
| 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: 78564009 | |||||||||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||||||||||||||||
| effective[x] |
SOΣC | 1..1 | dateTime | Date, and optionally time, the observation was performed Constraints: vs-1
| |||||||||||||||||||||
| Slices for value[x] |
SOΣC | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. Slice: Unordered, Closed by type:$this
| |||||||||||||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Heart rate
| |||||||||||||||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision)
| |||||||||||||||||||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||||||||||||||||||
| unit |
SOΣ | 1..1 | string | Unit representation
| |||||||||||||||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| |||||||||||||||||||||
| code |
SOΣ | 1..1 | code | Coded responses from the common UCUM units for vital signs value set. Fixed Value: /min
| |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| component |
SOΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. Constraints: vs-3
| |||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VitalSigns (extensible): This identifies the vital sign result type.
| |||||||||||||||||||||
| value[x] |
SOΣC | 0..1 | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
| ||||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||||||||||||
| valueString |
string | ||||||||||||||||||||||||
| valueBoolean |
boolean | ||||||||||||||||||||||||
| valueInteger |
integer | ||||||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||||||
| valueTime |
time | ||||||||||||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:VSCat | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.value[x]:valueQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x] | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| vs-1 | error | Observation.effective[x] | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
$this is dateTime implies $this.toString().length() >= 10
|
| vs-2 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present. |
(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
|
| vs-3 | error | Observation.component | If there is no a value a data absent reason must be present |
value.exists() or dataAbsentReason.exists()
|
Differential View
This structure is derived from AUCoreHeartRate
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
0..* | AUCoreHeartRate | Heart rate | ||||||||||||||||
| status |
O | 1..1 | code | registered | preliminary | final | amended +
| |||||||||||||||
| code |
|||||||||||||||||||
| coding |
3..* | Coding | Code defined by a terminology system | ||||||||||||||||
| Slices for coding |
Content/Rules for all slices | ||||||||||||||||||
| coding:snomedPulseRate |
SO | 1..1 | Coding | Code defined by a terminology system
| |||||||||||||||
| 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: 78564009 | ||||||||||||||||
| subject |
O | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||||||||||
| effective[x] |
O | 1..1 | dateTime | Date, and optionally time, the observation was performed
| |||||||||||||||
| value[x] |
O | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
| |||||||||||||||
| Slices for value[x] |
Content/Rules for all slices | ||||||||||||||||||
| value[x]:valueQuantity |
O | 0..1 | Quantity | Heart rate
| |||||||||||||||
| value |
O | 1..1 | decimal | Numerical value (with implicit precision)
| |||||||||||||||
| system |
O | 1..1 | uri | System that defines coded unit form
| |||||||||||||||
| code |
O | 1..1 | code | Coded responses from the common UCUM units for vital signs value set.
| |||||||||||||||
| Documentation for this format | |||||||||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUCoreHeartRate | Heart rate Constraints: obs-6, obs-7, vs-2 | |||||||||||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||||||
| 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 Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | |||||||||||||||||||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||||||||||||||||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||||||||||||||||||
| status |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required)
| |||||||||||||||||||||
| Slices for category |
SO | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
| category:VSCat |
SO | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| coding |
SOΣ | 1..* | Coding | Code defined by a terminology system
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| system |
SOΣ | 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 |
SOΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs
| |||||||||||||||||||||
| display |
Σ | 0..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 | |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Heart Rate Binding: VitalSigns (extensible): This identifies the vital sign result type.
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| Slices for coding |
Σ | 3..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | |||||||||||||||||||||
| coding:HeartRateCode |
Σ | 1..1 | Coding | Code defined by a terminology system | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| 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: http://loinc.org | |||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8867-4 | |||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||
| coding:snomedHeartRateCode |
Σ | 1..1 | Coding | SNOMED CT Heart Rate | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| 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: 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: 364075005 | |||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||
| coding:snomedPulseRate |
SOΣ | 1..1 | Coding | Code defined by a terminology system
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| 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: 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: 78564009 | |||||||||||||||||||||
| display |
Σ | 0..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 | |||||||||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||||||||||||||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||||||||||||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||||||||||||||||||
| effective[x] |
SOΣC | 1..1 | dateTime | Date, and optionally time, the observation was performed Constraints: vs-1
| |||||||||||||||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | |||||||||||||||||||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |||||||||||||||||||||
| Slices for value[x] |
SOΣC | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. Slice: Unordered, Closed by type:$this
| |||||||||||||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Heart rate
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision)
| |||||||||||||||||||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||||||||||||||||||
| unit |
SOΣ | 1..1 | string | Unit representation
| |||||||||||||||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| |||||||||||||||||||||
| code |
SOΣ | 1..1 | code | Coded responses from the common UCUM units for vital signs value set. Fixed Value: /min
| |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||||||||||||
| note |
0..* | Annotation | Comments about the observation | ||||||||||||||||||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site (preferred)Constraints: au-core-obs-01 | |||||||||||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | ||||||||||||||||||||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | ||||||||||||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | ||||||||||||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant | |||||||||||||||||||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant | |||||||||||||||||||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | ||||||||||||||||||||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | ||||||||||||||||||||||
| age |
0..1 | Range | Applicable age range, if relevant | ||||||||||||||||||||||
| text |
0..1 | string | Text based reference range in an observation | ||||||||||||||||||||||
| hasMember |
Σ | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components | |||||||||||||||||||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Related measurements the observation is made from | |||||||||||||||||||||
| component |
SOΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. Constraints: vs-3
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VitalSigns (extensible): This identifies the vital sign result type.
| |||||||||||||||||||||
| value[x] |
SOΣC | 0..1 | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
| ||||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||||||||||||
| valueString |
string | ||||||||||||||||||||||||
| valueBoolean |
boolean | ||||||||||||||||||||||||
| valueInteger |
integer | ||||||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||||||
| valueTime |
time | ||||||||||||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | ||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:VSCat | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.value[x]:valueQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.bodySite | Base | preferred |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| Observation.method | Base | example | Observation Methods | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x] | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | error | Observation.bodySite | If a coded body site is provided, at least one coding shall be from SNOMED CT |
coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
|
| 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-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.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()
|
| vs-1 | error | Observation.effective[x] | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
$this is dateTime implies $this.toString().length() >= 10
|
| vs-2 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present. |
(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
|
| vs-3 | error | Observation.component | If there is no a value a data absent reason must be present |
value.exists() or dataAbsentReason.exists()
|
This structure is derived from AUCoreHeartRate
Other representations of profile: CSV, Excel, Schematron