AU Core Implementation Guide
0.4.0-ci-build - CI Build Australia flag

AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.4.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

Resource Profile: AU Core Blood Pressure

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-bloodpressure Version: 0.4.0-ci-build
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreBloodPressure

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 resource includes SNOMED Clinical Terms™ (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. “SNOMED” and “SNOMED CT” are registered trademarks of the IHTSDO. The rights to use and implement or implementation of SNOMED CT content are limited to the extent it is necessary to allow for the end use of this material. No further rights are granted in respect of the International Release and no further use of any SNOMED CT content by any other party is permitted.

This material contains content from LOINC (http://loinc.org). LOINC is copyright © 1995-2021, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.

All copies of this resource must include this copyright statement and all information contained in this statement.

This profile sets minimum expectations for an Observation resource to record, search, and fetch blood pressure observations with standard coding and units of measure. It is based on the FHIR Blood Pressure 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.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for observations of blood pressure associated with a patient
  • Record or update an observation of blood pressure associated with a patient

Comparison with other national and international IGs

A resource conforming to this profile is conformant to:

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • 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.
  • Observations MAY have additional codes that translate or map to the Observation code or category codes. For example:
    • providing a local code
    • providing a more specific codes such as 8306-3 - Body height - lying in addition to 8302-2 - Body height. Several additional observation codes are provided in the FHIR core specification vital signs table.
  • Observations MAY have [component] observations to qualify the vital sign observation. For example, 8478-0 - Mean blood pressure, 8887-2 - Heart rate device type, 8326-1 - Type of body temperature device. Several of these are provided in the FHIR core specification vital signs table.

  • Because blood pressure values are communicated in the mandatory systolic and diastolic components:
    • Observation.value[x] element SHOULD be omitted
    • an Observation without a systolic or diastolic result value, SHOULD include a reason why the data is absent in Observation.component.dataAbsentReason

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from observation-bp

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* observation-bp Blood pressure
... status 1..1 code registered | preliminary | final | amended +
Fixed Value: final
... code
.... coding 2..* Coding Code defined by a terminology system
.... Slices for coding Content/Rules for all slices
..... coding:snomedBPCode 1..1 Coding SNOMED CT Blood Pressure
...... 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: 75367002
... subject 1..1 Reference(AU Core Patient) Who and/or what the observation is about
... dataAbsentReason 0..1 CodeableConcept Why the result is missing
... bodySite C 0..1 CodeableConcept Observed body part
Binding: Body Site . (extensible)
au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
... Slices for component Content/Rules for all slices
.... component:SystolicBP 1..1 BackboneElement Systolic Blood Pressure
..... code
...... Slices for coding Content/Rules for all slices
....... coding:snomedSBP 1..1 Coding SNOMED CT Systolic Blood Pressure
........ 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: 271649006
..... dataAbsentReason S 0..1 CodeableConcept Why the component result is missing
.... component:DiastolicBP 1..1 BackboneElement Diastolic Blood Pressure
..... code
...... Slices for coding Content/Rules for all slices
....... coding:snomedDBP 1..1 Coding SNOMED CT Diastolic Blood Pressure
........ 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: 271650006
..... dataAbsentReason S 0..1 CodeableConcept Why the component result is missing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.bodySiteextensibleBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* observation-bp Blood pressure
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.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Fixed Value: final
.... category:VSCat S 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding SΣ 1..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code SΣ 1..1 code Symbol in syntax defined by the system
Fixed Value: vital-signs
... code SΣ 1..1 CodeableConcept Blood Pressure
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:BPCode Σ 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: 85354-9
..... coding:snomedBPCode Σ 1..1 Coding SNOMED CT Blood Pressure
...... 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: 75367002
... subject SΣ 1..1 Reference(AU Core Patient) Who and/or what the observation is about
... effective[x] SΣ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
au-core-obs-01: Date shall be at least to 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
... dataAbsentReason SC 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 . (extensible)
au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
... Slices for component SΣC 2..* BackboneElement Used when reporting systolic and diastolic blood pressure.
Slice: Unordered, Open by value:code.coding.code, value:code.coding.system
vs-3: If there is no a value a data absent reason must be present
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: VitalSigns (extensible): This identifies the vital sign result type.

..... value[x] SΣC 0..1 Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): 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 SC 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... component:SystolicBP SΣC 1..1 BackboneElement Systolic 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 SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: VitalSigns (extensible): This identifies the vital sign result type.

...... Slices for coding Σ 2..* Coding Systolic Blood Pressure
Slice: Unordered, Open by value:code, value:system
....... coding:SBPCode Σ 1..1 Coding Systolic Blood Pressure
........ 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: 8480-6
....... coding:snomedSBP Σ 1..1 Coding SNOMED CT Systolic Blood Pressure
........ 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: 271649006
..... value[x] SΣC 0..1 Quantity Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): Common UCUM units for recording Vital Signs.

...... value SΣ 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 SΣ 1..1 string Unit representation
...... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ 1..1 code Coded responses from the common UCUM units for vital signs value set.
Fixed Value: mm[Hg]
..... dataAbsentReason SC 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... component:DiastolicBP SΣC 1..1 BackboneElement 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 SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: VitalSigns (extensible): This identifies the vital sign result type.

...... Slices for coding Σ 2..* Coding Diastolic Blood Pressure
Slice: Unordered, Open by value:code, value:system
....... coding:DBPCode Σ 1..1 Coding Diastolic Blood Pressure
........ 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: 8462-4
....... coding:snomedDBP Σ 1..1 Coding SNOMED CT Diastolic Blood Pressure
........ 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: 271650006
..... value[x] SΣC 0..1 Quantity Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): Common UCUM units for recording Vital Signs.

...... value SΣ 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 SΣ 1..1 string Unit representation
...... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ 1..1 code Coded responses from the common UCUM units for vital signs value set.
Fixed Value: mm[Hg]
..... dataAbsentReason SC 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredFixed Value: final
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:VSCatpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.bodySiteextensibleBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Observation.component.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:SystolicBP.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component:SystolicBP.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component:SystolicBP.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:SystolicBP.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:DiastolicBP.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component:DiastolicBP.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component:DiastolicBP.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:DiastolicBP.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf 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()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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-1errorObservation.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-2errorObservationIf 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-3errorObservation.component, Observation.component:SystolicBP, Observation.component:DiastolicBPIf there is no a value a data absent reason must be present
: value.exists() or dataAbsentReason.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* observation-bp Blood pressure
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.
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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 ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Fixed Value: final
... Slices for category S 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 S 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 SΣ 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 SΣ 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 SΣ 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 SΣ 1..1 CodeableConcept Blood Pressure
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:BPCode Σ 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: 85354-9
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:snomedBPCode Σ 1..1 Coding SNOMED CT Blood Pressure
...... 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: 75367002
...... 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 SΣ 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] SΣ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
au-core-obs-01: Date shall be at least to 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
... dataAbsentReason SC 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 . (extensible)
au-core-obs-04: 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
... Slices for component SΣC 2..* BackboneElement Used when reporting systolic and diastolic blood pressure.
Slice: Unordered, Open by value:code.coding.code, value:code.coding.system
vs-3: If there is no a value a data absent reason must be present
.... component:All Slices Content/Rules for all slices
..... 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 SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: VitalSigns (extensible): This identifies the vital sign result type.

..... value[x] SΣC 0..1 Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): 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 SC 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
.... component:SystolicBP SΣC 1..1 BackboneElement Systolic 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 SΣ 1..1 CodeableConcept Type of component observation (code / type)
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 Systolic Blood Pressure
Slice: Unordered, Open by value:code, value:system
....... coding:SBPCode Σ 1..1 Coding Systolic Blood Pressure
........ 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: 8480-6
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... coding:snomedSBP Σ 1..1 Coding SNOMED CT Systolic Blood Pressure
........ 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: 271649006
........ 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
..... value[x] SΣC 0..1 Quantity Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): Common UCUM units for recording Vital Signs.

...... 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 SΣ 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 SΣ 1..1 string Unit representation
...... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ 1..1 code Coded responses from the common UCUM units for vital signs value set.
Fixed Value: mm[Hg]
..... dataAbsentReason SC 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
.... component:DiastolicBP SΣC 1..1 BackboneElement 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 SΣ 1..1 CodeableConcept Type of component observation (code / type)
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 Diastolic Blood Pressure
Slice: Unordered, Open by value:code, value:system
....... coding:DBPCode Σ 1..1 Coding Diastolic Blood Pressure
........ 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: 8462-4
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... coding:snomedDBP Σ 1..1 Coding SNOMED CT Diastolic Blood Pressure
........ 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: 271650006
........ 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
..... value[x] SΣC 0..1 Quantity Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): Common UCUM units for recording Vital Signs.

...... 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 SΣ 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 SΣ 1..1 string Unit representation
...... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ 1..1 code Coded responses from the common UCUM units for vital signs value set.
Fixed Value: mm[Hg]
..... dataAbsentReason SC 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredFixed Value: final
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:VSCatpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteextensibleBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:SystolicBP.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component:SystolicBP.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component:SystolicBP.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:SystolicBP.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:SystolicBP.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:DiastolicBP.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component:DiastolicBP.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component:DiastolicBP.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:DiastolicBP.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:DiastolicBP.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf 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()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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-1errorObservation.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-2errorObservationIf 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-3errorObservation.component, Observation.component:SystolicBP, Observation.component:DiastolicBPIf there is no a value a data absent reason must be present
: value.exists() or dataAbsentReason.exists()

This structure is derived from observation-bp

Summary

Mandatory: 9 elements
Must-Support: 2 elements
Fixed: 7 elements

Structures

This structure refers to these other structures:

Maturity: 0

Differential View

This structure is derived from observation-bp

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* observation-bp Blood pressure
... status 1..1 code registered | preliminary | final | amended +
Fixed Value: final
... code
.... coding 2..* Coding Code defined by a terminology system
.... Slices for coding Content/Rules for all slices
..... coding:snomedBPCode 1..1 Coding SNOMED CT Blood Pressure
...... 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: 75367002
... subject 1..1 Reference(AU Core Patient) Who and/or what the observation is about
... dataAbsentReason 0..1 CodeableConcept Why the result is missing
... bodySite C 0..1 CodeableConcept Observed body part
Binding: Body Site . (extensible)
au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
... Slices for component Content/Rules for all slices
.... component:SystolicBP 1..1 BackboneElement Systolic Blood Pressure
..... code
...... Slices for coding Content/Rules for all slices
....... coding:snomedSBP 1..1 Coding SNOMED CT Systolic Blood Pressure
........ 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: 271649006
..... dataAbsentReason S 0..1 CodeableConcept Why the component result is missing
.... component:DiastolicBP 1..1 BackboneElement Diastolic Blood Pressure
..... code
...... Slices for coding Content/Rules for all slices
....... coding:snomedDBP 1..1 Coding SNOMED CT Diastolic Blood Pressure
........ 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: 271650006
..... dataAbsentReason S 0..1 CodeableConcept Why the component result is missing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.bodySiteextensibleBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* observation-bp Blood pressure
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.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Fixed Value: final
.... category:VSCat S 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding SΣ 1..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code SΣ 1..1 code Symbol in syntax defined by the system
Fixed Value: vital-signs
... code SΣ 1..1 CodeableConcept Blood Pressure
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:BPCode Σ 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: 85354-9
..... coding:snomedBPCode Σ 1..1 Coding SNOMED CT Blood Pressure
...... 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: 75367002
... subject SΣ 1..1 Reference(AU Core Patient) Who and/or what the observation is about
... effective[x] SΣ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
au-core-obs-01: Date shall be at least to 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
... dataAbsentReason SC 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 . (extensible)
au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
... Slices for component SΣC 2..* BackboneElement Used when reporting systolic and diastolic blood pressure.
Slice: Unordered, Open by value:code.coding.code, value:code.coding.system
vs-3: If there is no a value a data absent reason must be present
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: VitalSigns (extensible): This identifies the vital sign result type.

..... value[x] SΣC 0..1 Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): 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 SC 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... component:SystolicBP SΣC 1..1 BackboneElement Systolic 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 SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: VitalSigns (extensible): This identifies the vital sign result type.

...... Slices for coding Σ 2..* Coding Systolic Blood Pressure
Slice: Unordered, Open by value:code, value:system
....... coding:SBPCode Σ 1..1 Coding Systolic Blood Pressure
........ 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: 8480-6
....... coding:snomedSBP Σ 1..1 Coding SNOMED CT Systolic Blood Pressure
........ 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: 271649006
..... value[x] SΣC 0..1 Quantity Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): Common UCUM units for recording Vital Signs.

...... value SΣ 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 SΣ 1..1 string Unit representation
...... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ 1..1 code Coded responses from the common UCUM units for vital signs value set.
Fixed Value: mm[Hg]
..... dataAbsentReason SC 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... component:DiastolicBP SΣC 1..1 BackboneElement 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 SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: VitalSigns (extensible): This identifies the vital sign result type.

...... Slices for coding Σ 2..* Coding Diastolic Blood Pressure
Slice: Unordered, Open by value:code, value:system
....... coding:DBPCode Σ 1..1 Coding Diastolic Blood Pressure
........ 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: 8462-4
....... coding:snomedDBP Σ 1..1 Coding SNOMED CT Diastolic Blood Pressure
........ 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: 271650006
..... value[x] SΣC 0..1 Quantity Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): Common UCUM units for recording Vital Signs.

...... value SΣ 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 SΣ 1..1 string Unit representation
...... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ 1..1 code Coded responses from the common UCUM units for vital signs value set.
Fixed Value: mm[Hg]
..... dataAbsentReason SC 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredFixed Value: final
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:VSCatpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.bodySiteextensibleBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Observation.component.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:SystolicBP.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component:SystolicBP.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component:SystolicBP.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:SystolicBP.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:DiastolicBP.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component:DiastolicBP.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component:DiastolicBP.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:DiastolicBP.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf 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()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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-1errorObservation.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-2errorObservationIf 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-3errorObservation.component, Observation.component:SystolicBP, Observation.component:DiastolicBPIf there is no a value a data absent reason must be present
: value.exists() or dataAbsentReason.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* observation-bp Blood pressure
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.
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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 ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Fixed Value: final
... Slices for category S 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 S 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 SΣ 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 SΣ 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 SΣ 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 SΣ 1..1 CodeableConcept Blood Pressure
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:BPCode Σ 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: 85354-9
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:snomedBPCode Σ 1..1 Coding SNOMED CT Blood Pressure
...... 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: 75367002
...... 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 SΣ 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] SΣ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
au-core-obs-01: Date shall be at least to 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
... dataAbsentReason SC 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 . (extensible)
au-core-obs-04: 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
... Slices for component SΣC 2..* BackboneElement Used when reporting systolic and diastolic blood pressure.
Slice: Unordered, Open by value:code.coding.code, value:code.coding.system
vs-3: If there is no a value a data absent reason must be present
.... component:All Slices Content/Rules for all slices
..... 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 SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: VitalSigns (extensible): This identifies the vital sign result type.

..... value[x] SΣC 0..1 Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): 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 SC 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
.... component:SystolicBP SΣC 1..1 BackboneElement Systolic 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 SΣ 1..1 CodeableConcept Type of component observation (code / type)
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 Systolic Blood Pressure
Slice: Unordered, Open by value:code, value:system
....... coding:SBPCode Σ 1..1 Coding Systolic Blood Pressure
........ 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: 8480-6
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... coding:snomedSBP Σ 1..1 Coding SNOMED CT Systolic Blood Pressure
........ 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: 271649006
........ 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
..... value[x] SΣC 0..1 Quantity Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): Common UCUM units for recording Vital Signs.

...... 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 SΣ 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 SΣ 1..1 string Unit representation
...... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ 1..1 code Coded responses from the common UCUM units for vital signs value set.
Fixed Value: mm[Hg]
..... dataAbsentReason SC 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
.... component:DiastolicBP SΣC 1..1 BackboneElement 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 SΣ 1..1 CodeableConcept Type of component observation (code / type)
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 Diastolic Blood Pressure
Slice: Unordered, Open by value:code, value:system
....... coding:DBPCode Σ 1..1 Coding Diastolic Blood Pressure
........ 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: 8462-4
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... coding:snomedDBP Σ 1..1 Coding SNOMED CT Diastolic Blood Pressure
........ 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: 271650006
........ 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
..... value[x] SΣC 0..1 Quantity Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required): Common UCUM units for recording Vital Signs.

...... 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 SΣ 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 SΣ 1..1 string Unit representation
...... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ 1..1 code Coded responses from the common UCUM units for vital signs value set.
Fixed Value: mm[Hg]
..... dataAbsentReason SC 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredFixed Value: final
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:VSCatpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteextensibleBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:SystolicBP.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component:SystolicBP.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component:SystolicBP.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:SystolicBP.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:SystolicBP.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:DiastolicBP.codeextensibleVitalSigns
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component:DiastolicBP.value[x]requiredVitalSignsUnits
http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
from the FHIR Standard
Observation.component:DiastolicBP.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:DiastolicBP.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:DiastolicBP.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf 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()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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-1errorObservation.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-2errorObservationIf 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-3errorObservation.component, Observation.component:SystolicBP, Observation.component:DiastolicBPIf there is no a value a data absent reason must be present
: value.exists() or dataAbsentReason.exists()

This structure is derived from observation-bp

Summary

Mandatory: 9 elements
Must-Support: 2 elements
Fixed: 7 elements

Structures

This structure refers to these other structures:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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 SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
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 client SHALL provide both the system and code values. The server SHALL support both. The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
category MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. The client SHALL support search using the 'vital-signs' category defined in each profile. The server SHALL support search using the 'vital-signs' category defined in each profile.
code MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. The client SHALL support search using the LOINC codes defined in each profile. The server SHALL support search using the LOINC codes defined in each profile.
date MAY date A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset.
status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using the patient search parameter:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Observation?patient={Type/}[id] or optionally GET [base]/Observation?patient.identifier=[system|][code]

    Example:

    1. GET [base]/Observation?patient=5678
    2. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    3. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient (how to search by reference and how to search by token)

  2. SHALL support searching using the combination of the patient and category search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Observation?patient={Type/}[id]&category=vital-signs

    Example:

    1. GET [base]/Observation?patient=5678&category=vital-signs

    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)

  3. SHALL support searching using the combination of the patient and category and date search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/Observation?patient={Type/}[id]&category=vital-signs&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Observation?patient=5678&category=vital-signs&date=ge2020-01-01T00:00:00Z

    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)

  4. SHALL support searching using the combination of the patient and code search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)

    GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Observation?patient=5678&code=http://snomed.info/sct|364075005,http://loinc.org|85354-9,http://loinc.org|85354-9

    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)

Optional Search Parameters:

The following search parameters and search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and category and status search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support multipleOr search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/Observation?patient={Type/}[id]&category=vital-signs&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Observation?patient=5678&category=vital-signs&status=final
    2. GET [base]/Observation?patient=5678&category=vital-signs&

    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)

  2. SHOULD support searching using the combination of the patient and code and date search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Observation?patient=5678&code=http://snomed.info/sct|364075005,http://loinc.org|85354-9,http://loinc.org|85354-9&date=ge2020-01-01T00:00:00Z
    2. GET [base]/Observation?patient.identifier=http://example.org/fhir/mrn|12345&code=http://snomed.info/sct|364075005,http://loinc.org|85354-9,http://loinc.org|85354-9&date=ge2020-01-01T00:00:00Z

    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)