AU Core Implementation Guide
1.0.0-ci-build - CI Build
AU Core Implementation Guide
1.0.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-resprate | Version: 1.0.0-ci-build | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: AUCoreRespirationRate | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for an Observation resource to record, search, and fetch respiration rate observations with standard coding and units of measure. It is based on the FHIR Respiratory Rate Profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
The following are supported usage scenarios for this profile:
Observation.category provides an efficient way of supporting system interactions, e.g. restricting searches. Implementers need to understand that data categorisation is somewhat subjective. The categorisation applied by the source may not align with a receiver’s expectations.Usage:
Changes since version 1.0.0-ballot:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from observation-resprate
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
C | 0..* | observation-resprate | Respiration rate au-core-obs-02: At least value or data absent reason shall be present | ||||||
  status |
O | 1..1 | code | registered | preliminary | final | amended +
| ||||||
| category |
O | 1..* | CodeableConcept | Classification of type of observation
| ||||||
  Slices for category |
Content/Rules for all slices | |||||||||
   category:VSCat |
O | 1..1 | CodeableConcept | Classification of type of observation
| ||||||
  coding |
O | 1..* | Coding | Code defined by a terminology system
| ||||||
| system |
O | 1..1 | uri | Identity of the terminology system
| ||||||
 code |
O | 1..1 | code | Symbol in syntax defined by the system
| ||||||
| code |
O | 1..1 | CodeableConcept | Respiratory Rate
| ||||||
| coding |
2..* | Coding | Code defined by a terminology system | |||||||
 Slices for coding |
Content/Rules for all slices | |||||||||
| coding:snomedRespRateCode |
1..1 | Coding | SNOMED CT Respiration 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: 86290005 | |||||||
 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
| ||||||
| valueQuantity |
OC | 0..1 | Quantity | Respiration rate
| ||||||
| value |
O | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||
| unit |
O | 1..1 | string | Unit representation
| ||||||
| 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.
| ||||||
| dataAbsentReason |
OC | 0..1 | CodeableConcept | Why the result is missing
| ||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site  (preferred)au-core-obs-01: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||||
| component |
O | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure.
| ||||||
| code |
O | 1..1 | CodeableConcept | Type of component observation (code / type)
| ||||||
| value[x] |
O | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Vital Sign Value recorded with UCUM
| ||||||
| dataAbsentReason |
O | 0..1 | CodeableConcept | Why the component result is missing
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-02 | error | Observation | At least value or data absent reason shall be present : dataAbsentReason.exists() or value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | observation-resprate | Respiration rate 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 vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present. au-core-obs-02: At least value or data absent reason shall be present | ||||||
| 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 | Respiratory Rate Binding: VitalSigns (extensible): This identifies the vital sign result type.
| ||||||
| Slices for coding |
Σ | 2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | ||||||
 coding:RespRateCode |
Σ | 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: 9279-1 | ||||||
| coding:snomedRespRateCode |
Σ | 1..1 | Coding | SNOMED CT Respiration 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: 86290005 | ||||||
| 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 vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day
| ||||||
| Slices for value[x] |
SΣ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 | Respiration 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.
| ||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site (preferred)au-core-obs-01: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||||
| component |
SOΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. vs-3: If there is no a value a data absent reason must be present
| ||||||
| 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 | ||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.category:VSCat | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | |
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | |
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | |
| Observation.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| Observation.component.code | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | |
| Observation.component.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1from the FHIR Standard | |
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-02 | error | Observation | At least value or data absent reason shall be present : dataAbsentReason.exists() or value.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-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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | observation-resprate | Respiration rate 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 vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present. au-core-obs-02: At least value or data absent reason shall be present | ||||||
| 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 | |||||||
| 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 | Respiratory 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 |
Σ | 2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | ||||||
| coding:RespRateCode |
Σ | 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: 9279-1 | ||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
| coding:snomedRespRateCode |
Σ | 1..1 | Coding | SNOMED CT Respiration 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: 86290005 | ||||||
| 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 vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day
| ||||||
| 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] |
SΣ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 | Respiration 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)au-core-obs-01: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||||
| 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 obs-3: Must have at least a low or a high or text | ||||||
| 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 | Low Range, if relevant | ||||||
| high |
C | 0..1 | SimpleQuantity | 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. vs-3: If there is no a value a data absent reason must be present
| ||||||
| 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 | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.category:VSCat | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | ||||
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | ||||
| Observation.component.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1from the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-02 | error | Observation | At least value or data absent reason shall be present : dataAbsentReason.exists() or value.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 observation-resprate
Summary
Mandatory: 3 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from observation-resprate
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | observation-resprate | Respiration rate au-core-obs-02: At least value or data absent reason shall be present | ||||||
| status |
O | 1..1 | code | registered | preliminary | final | amended +
| ||||||
| category |
O | 1..* | CodeableConcept | Classification of type of observation
| ||||||
| Slices for category |
Content/Rules for all slices | |||||||||
| category:VSCat |
O | 1..1 | CodeableConcept | Classification of type of observation
| ||||||
| coding |
O | 1..* | Coding | Code defined by a terminology system
| ||||||
| system |
O | 1..1 | uri | Identity of the terminology system
| ||||||
| code |
O | 1..1 | code | Symbol in syntax defined by the system
| ||||||
| code |
O | 1..1 | CodeableConcept | Respiratory Rate
| ||||||
| coding |
2..* | Coding | Code defined by a terminology system | |||||||
| Slices for coding |
Content/Rules for all slices | |||||||||
| coding:snomedRespRateCode |
1..1 | Coding | SNOMED CT Respiration 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: 86290005 | |||||||
| 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
| ||||||
| valueQuantity |
OC | 0..1 | Quantity | Respiration rate
| ||||||
| value |
O | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||
| unit |
O | 1..1 | string | Unit representation
| ||||||
| 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.
| ||||||
| dataAbsentReason |
OC | 0..1 | CodeableConcept | Why the result is missing
| ||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site (preferred)au-core-obs-01: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||||
| component |
O | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure.
| ||||||
| code |
O | 1..1 | CodeableConcept | Type of component observation (code / type)
| ||||||
| value[x] |
O | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Vital Sign Value recorded with UCUM
| ||||||
| dataAbsentReason |
O | 0..1 | CodeableConcept | Why the component result is missing
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-02 | error | Observation | At least value or data absent reason shall be present : dataAbsentReason.exists() or value.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | observation-resprate | Respiration rate 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 vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present. au-core-obs-02: At least value or data absent reason shall be present | ||||||
| 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 | Respiratory Rate Binding: VitalSigns (extensible): This identifies the vital sign result type.
| ||||||
| Slices for coding |
Σ | 2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | ||||||
| coding:RespRateCode |
Σ | 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: 9279-1 | ||||||
| coding:snomedRespRateCode |
Σ | 1..1 | Coding | SNOMED CT Respiration 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: 86290005 | ||||||
| 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 vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day
| ||||||
| Slices for value[x] |
SΣ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 | Respiration 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.
| ||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site (preferred)au-core-obs-01: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||||
| component |
SOΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. vs-3: If there is no a value a data absent reason must be present
| ||||||
| 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 | ||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.category:VSCat | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | |
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | |
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | |
| Observation.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| Observation.component.code | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | |
| Observation.component.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1from the FHIR Standard | |
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-02 | error | Observation | At least value or data absent reason shall be present : dataAbsentReason.exists() or value.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-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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | observation-resprate | Respiration rate 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 vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present. au-core-obs-02: At least value or data absent reason shall be present | ||||||
| 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 | |||||||
| 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 | Respiratory 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 |
Σ | 2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | ||||||
| coding:RespRateCode |
Σ | 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: 9279-1 | ||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
| coding:snomedRespRateCode |
Σ | 1..1 | Coding | SNOMED CT Respiration 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: 86290005 | ||||||
| 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 vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day
| ||||||
| 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] |
SΣ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 | Respiration 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)au-core-obs-01: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||||
| 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 obs-3: Must have at least a low or a high or text | ||||||
| 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 | Low Range, if relevant | ||||||
| high |
C | 0..1 | SimpleQuantity | 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. vs-3: If there is no a value a data absent reason must be present
| ||||||
| 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 | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.category:VSCat | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | ||||
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | ||||
| Observation.component.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1from the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-02 | error | Observation | At least value or data absent reason shall be present : dataAbsentReason.exists() or value.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 observation-resprate
Summary
Mandatory: 3 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| patient+category | SHALL | reference+token |
|
| patient+category+date | SHALL | reference+token+date |
|
| patient+code | SHALL | reference+token |
|
| patient+category+status | SHOULD | reference+token+token |
|
| patient+code+date | SHOULD | reference+token+date |
|
| patient.identifier | SHOULD | reference.token |
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
| patient | MAY | reference |
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
| category | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. The requester SHALL support search using the 'vital-signs' category defined in this profile. The responder SHALL support search using the 'vital-signs' category defined in this profile. |
| code | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. The requester SHALL support search using the LOINC codes defined in this profile. The responder SHALL support search using the LOINC codes defined in this profile. |
| date | MAY | date |
A requester SHALL provide a value precise to the second + time offset. A responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators gt, lt, ge, le. The responder SHALL support these search comparators gt, lt, ge, le.The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le. The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le. |
| status | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. The requester SHALL support multipleOr.The responder SHALL support multipleOr. |
The following search parameters and search parameter combinations SHALL be supported:
patient and category search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Observation?patient={Type/}[id]&category=vital-signs
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category (how to search by reference and how to search by token)
patient and category and date search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])date comparators: gt,lt,ge,ledate (e.g.date=[date]&date=[date]]&...), and if multipleAnd is supported, SHALL support the search comparators gt,lt,ge,leGET [base]/Observation?patient={Type/}[id]&category=vital-signs&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and a category code = vital-signs (how to search by reference and how to search by token and how to search by date)
patient and code search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])code (e.g.code={system|}[code],{system|}[code],...)GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and observation code(s). The Observation code parameter searches Observation.code only. (how to search by reference and how to search by token)
The following search parameters and search parameter combinations SHOULD be supported:
SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
GET [base]/Observation?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient (how to search by reference and how to search by token)
patient and category and status search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])status (e.g.status={system|}[code],{system|}[code],...)GET [base]/Observation?patient={Type/}[id]&category=vital-signs&status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category and status (how to search by reference and how to search by token)
patient and code and date search parameters:
patient.identifier (e.g. patient.identifier=[system|][code]code (e.g.code={system|}[code],{system|}[code],...)date comparators: gt,lt,ge,ledate (e.g.date=[date]&date=[date]]&...), and if multipleAnd is supported, SHALL support the search comparators gt,lt,ge,leGET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and observation code(s) (how to search by reference and how to search by token and how to search by date)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#1.0.0-ci-build based on FHIR 4.0.1. Generated 2024-12-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change