AU Core Implementation Guide
0.2.1-preview - Preview
AU Core Implementation Guide
0.2.1-preview - Preview
This page is part of the Australian Core IG (v0.2.1-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-vitalspanel | Version: 0.2.1-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreVitalsPanel | ||
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 vital signs panel observations with standard coding. It is based on the core FHIR Vital Signs Panel Profile profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are example usage scenarios for this profile:
A resource conforming to this profile is conformant to:
No equivalent US Core profile.
Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access or International Patient Summary MAY NOT conform to AU Core.
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from observation-vitalspanel
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | observation-vitalspanel | Vital signs panel | |
  status | 1..1 | code | registered | preliminary | final | amended + Fixed Value: final | |
 code | ||||
 coding | 1..* | Coding | Code defined by a terminology system | |
  coding:VitalsPanelCode | 1..1 | Coding | Code defined by a terminology system | |
  system | 1..1 | uri | Identity of the terminology system | |
 code | 1..1 | code | Symbol in syntax defined by the system | |
 subject | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about | |
| encounter | S | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made |
 effective[x] | C | 1..1 | dateTime | Date, and optionally time, the observation was performed au-core-obs-01: Date shall be at least to day |
 performer | S | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | observation-vitalspanel | Vital signs panel |
| 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 |
 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. |
  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 | Vital Signs Panel Binding: VitalSigns (extensible): This identifies the vital sign result type. |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system |
| coding:VitalsPanelCode | Σ | 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: 85353-1 |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
| encounter | SΣ | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made |
| effective[x] | SΣC | 1..1 | dateTime | Date, and optionally time, the observation was performed au-core-obs-01: Date shall be at least to day |
| performer | SΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation |
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| hasMember | SΣ | 1..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
| component | SΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. |
| 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. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.status | required | Fixed Value: final |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.category:VSCat | preferred | ObservationCategoryCodes |
| Observation.code | extensible | VitalSigns |
| Observation.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component.code | extensible | VitalSigns |
| Observation.component.value[x] | required | VitalSignsUnits |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | observation-vitalspanel | Vital signs panel | ||||
| 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 | ?!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 | Vital Signs Panel 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 | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | ||||
| coding:VitalsPanelCode | Σ | 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: 85353-1 | ||||
| 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 | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter | SΣ | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] | SΣC | 1..1 | dateTime | Date, and optionally time, the observation was performed au-core-obs-01: Date shall be at least to day | ||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | SΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation | ||||
| 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 | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| 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 | ||||
| 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 | SΣ | 1..* | 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 | SΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | Fixed Value: final | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.category:VSCat | preferred | ObservationCategoryCodes | ||||
| Observation.code | extensible | VitalSigns | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | extensible | VitalSigns | ||||
| Observation.component.value[x] | required | VitalSignsUnits | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
This structure is derived from observation-vitalspanel
Summary
Mandatory: 4 elements
Must-Support: 2 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from observation-vitalspanel
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | observation-vitalspanel | Vital signs panel | |
| status | 1..1 | code | registered | preliminary | final | amended + Fixed Value: final | |
| code | ||||
| coding | 1..* | Coding | Code defined by a terminology system | |
| coding:VitalsPanelCode | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| subject | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about | |
| encounter | S | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made |
| effective[x] | C | 1..1 | dateTime | Date, and optionally time, the observation was performed au-core-obs-01: Date shall be at least to day |
| performer | S | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | observation-vitalspanel | Vital signs panel |
| 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 |
| 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. |
| 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 | Vital Signs Panel Binding: VitalSigns (extensible): This identifies the vital sign result type. |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system |
| coding:VitalsPanelCode | Σ | 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: 85353-1 |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
| encounter | SΣ | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made |
| effective[x] | SΣC | 1..1 | dateTime | Date, and optionally time, the observation was performed au-core-obs-01: Date shall be at least to day |
| performer | SΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation |
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| hasMember | SΣ | 1..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
| component | SΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. |
| 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. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.status | required | Fixed Value: final |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.category:VSCat | preferred | ObservationCategoryCodes |
| Observation.code | extensible | VitalSigns |
| Observation.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component.code | extensible | VitalSigns |
| Observation.component.value[x] | required | VitalSignsUnits |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | observation-vitalspanel | Vital signs panel | ||||
| 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 | ?!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 | Vital Signs Panel 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 | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | ||||
| coding:VitalsPanelCode | Σ | 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: 85353-1 | ||||
| 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 | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter | SΣ | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] | SΣC | 1..1 | dateTime | Date, and optionally time, the observation was performed au-core-obs-01: Date shall be at least to day | ||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | SΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation | ||||
| 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 | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| 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 | ||||
| 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 | SΣ | 1..* | 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 | SΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | Fixed Value: final | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.category:VSCat | preferred | ObservationCategoryCodes | ||||
| Observation.code | extensible | VitalSigns | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | extensible | VitalSigns | ||||
| Observation.component.value[x] | required | VitalSignsUnits | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
This structure is derived from observation-vitalspanel
Summary
Mandatory: 4 elements
Must-Support: 2 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described 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. |
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching using the patient search parameter:
- SHALL support these _revinclude parameters: Provenance:target
- 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:
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 search parameters:
_revinclude parameters: Provenance:targetpatient.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:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])date comparators: gt,lt,ge,ledate (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:
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:
_revinclude parameters: Provenance:targetpatient.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:
patient and category and status search parameters:
_revinclude parameters: Provenance:targetpatient.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:
_revinclude parameters: Provenance:targetpatient.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]]&...)GET [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#0.2.1-preview based on FHIR 4.0.1. Generated 2023-08-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change