Australian CVD Risk Calculator
Iteration3 - ci-build
Australian CVD Risk Calculator
Iteration3 - ci-build
Australian CVD Risk Calculator - Local Development build (vIteration3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://www.cvdcheck.org.au/fhir/StructureDefinition/CVDRiskResult | Version: Iteration3 | |||
| Draft as of 2025-05-19 | Computable Name: CVDRiskResult | |||
Copyright/Legal: Copyright © 2024+ National Heart Foundation of Australia - All rights reserved. This content is not available under an open source licence. |
||||
This profile sets the expectations for an Observation resource to record a cardiovascular disease risk result as an output of using the Aus CVD Risk-i application.
Observation.value[x].Observation.interpretation. Categories are based on the CVD Risk Guidelines.| Category | Result | Additional Information |
|---|---|---|
| Low Risk | < 5 | Recorded as valueQuantity using a comparator. |
| Intermediate Risk | 5 – 9 | Recorded as valueRange. FHIR range boundaries are inclusive. |
| High Risk | ≥ 10 | Recorded as valueQuantity using a comparator. |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
C | 0..* | Observation | Cardiovascular disease risk assessment result in an Australia context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 | ||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||
| contained |
SOC | 0..* | Resource | Contained, inline Resources au-cvd-ro-01: A contained QuestionnaireResponse resource SHALL be present.
| ||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
| status |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. ele-1: All FHIR elements must have a @value or children Fixed Value: final
| ||||||||
  category |
SO | 1..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. ele-1: All FHIR elements must have a @value or children
| ||||||||
  coding |
SOΣ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
| ||||||||
 system |
SOΣ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
| ||||||||
 code |
SOΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: social-history
| ||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. ele-1: All FHIR elements must have a @value or children
| ||||||||
| coding |
SOΣ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
| ||||||||
| system |
SOΣ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://snomed.info/sct
| ||||||||
| code |
SOΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: 441829007
| ||||||||
 subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about ele-1: All FHIR elements must have a @value or children
| ||||||||
| encounter |
SOΣ | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made ele-1: All FHIR elements must have a @value or children
| ||||||||
| effective[x] |
SOΣ | 1..1 | dateTime | Clinically relevant time/time-period for observation ele-1: All FHIR elements must have a @value or children
| ||||||||
| performer |
SOΣ | 0..* | Reference(AU Core Practitioner) | Who is responsible for the observation ele-1: All FHIR elements must have a @value or children
| ||||||||
 Slices for value[x] |
SOΣC | 1..1 | Cardiovascular disease risk represented as a percentage Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
| |||||||||
 valueQuantity |
Quantity | |||||||||||
| valueRange |
Range | |||||||||||
  value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result ele-1: All FHIR elements must have a @value or children
| ||||||||
  value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children
| ||||||||
| comparator |
?!SOΣ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children Fixed Value: http://unitsofmeasure.org
| ||||||||
 code |
SOΣ | 1..1 | code | Coded form of the unit ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
 value[x]:valueRange |
SOΣC | 0..1 | Range | Actual result ele-1: All FHIR elements must have a @value or children
| ||||||||
 low |
Σ | 0..1 | SimpleQuantity | Low limit ele-1: All FHIR elements must have a @value or children | ||||||||
 value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
 high |
Σ | 0..1 | SimpleQuantity | High limit ele-1: All FHIR elements must have a @value or children | ||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
| interpretation |
SO | 1..1 | CodeableConcept | Cardiovascular disease risk category Binding: Aus CVD Risk Category (required) ele-1: All FHIR elements must have a @value or children
| ||||||||
| derivedFrom |
SOΣ | 0..* | Reference(QuestionnaireResponse) | Related measurements the observation is made from ele-1: All FHIR elements must have a @value or children
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | |
| Observation.interpretation | required | AusCVDRiskCategoryhttps://www.cvdcheck.org.au/fhir/ValueSet/AusCVDRiskCategory-1from this IG |
| Id | Grade | Path(s) | Details | Requirements |
| au-cvd-ro-01 | error | Observation.contained | A contained QuestionnaireResponse resource SHALL be present. : exists($this is QuestionnaireResponse) | |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
This structure is derived from Observation
| Path | Conformance | ValueSet | URI |
| Observation.interpretation | required | AusCVDRiskCategoryhttps://www.cvdcheck.org.au/fhir/ValueSet/AusCVDRiskCategory-1from this IG |
| Id | Grade | Path(s) | Details | Requirements |
| au-cvd-ro-01 | error | Observation.contained | A contained QuestionnaireResponse resource SHALL be present. : exists($this is QuestionnaireResponse) |
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Cardiovascular disease risk assessment result in an Australia context obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||||||
| id |
Σ | 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 |
SOC | 0..* | Resource | Contained, inline Resources au-cvd-ro-01: A contained QuestionnaireResponse resource SHALL be present.
| ||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | ||||||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||||||
| status |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final
| ||||||||
| category |
SO | 1..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 1..* | Coding | Code defined by a terminology system
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| system |
SOΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
| ||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||
| code |
SOΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history
| ||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 1..* | Coding | Code defined by a terminology system
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| system |
SOΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
| ||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||
| code |
SOΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 441829007
| ||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| ||||||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||||||
| encounter |
SOΣ | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made
| ||||||||
| effective[x] |
SOΣ | 1..1 | dateTime | Clinically relevant time/time-period for observation
| ||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||||||
| performer |
SOΣ | 0..* | Reference(AU Core Practitioner) | Who is responsible for the observation
| ||||||||
| Slices for value[x] |
SOΣC | 1..1 | Cardiovascular disease risk represented as a percentage Slice: Unordered, Closed by type:$this
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueRange |
Range | |||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||||
| comparator |
?!SOΣ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit Fixed Value: %
| ||||||||
| value[x]:valueRange |
SOΣC | 0..1 | Range | Actual result
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| low |
Σ | 0..1 | SimpleQuantity | Low limit | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit Fixed Value: %
| ||||||||
| high |
Σ | 0..1 | SimpleQuantity | High limit | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit Fixed Value: %
| ||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||
| interpretation |
SO | 1..1 | CodeableConcept | Cardiovascular disease risk category Binding: Aus CVD Risk Category (required)
| ||||||||
| 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 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(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||||||
| derivedFrom |
SOΣ | 0..* | Reference(QuestionnaireResponse) | Related measurements the observation is made from
| ||||||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||||||
| 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 |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||||||
 value[x] |
Σ | 0..1 | Actual component result | |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| dataAbsentReason |
C | 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 | URI | |||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | required | AusCVDRiskCategoryhttps://www.cvdcheck.org.au/fhir/ValueSet/AusCVDRiskCategory-1from this IG | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-cvd-ro-01 | error | Observation.contained | A contained QuestionnaireResponse resource SHALL be present. : exists($this is QuestionnaireResponse) | |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
This structure is derived from Observation
Summary
Mandatory: 11 elements(12 nested mandatory elements)
Must-Support: 32 elements
Fixed: 14 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Cardiovascular disease risk assessment result in an Australia context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||
| contained |
SOC | 0..* | Resource | Contained, inline Resources au-cvd-ro-01: A contained QuestionnaireResponse resource SHALL be present.
| ||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
| status |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. ele-1: All FHIR elements must have a @value or children Fixed Value: final
| ||||||||
| category |
SO | 1..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. ele-1: All FHIR elements must have a @value or children
| ||||||||
| coding |
SOΣ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
| ||||||||
| system |
SOΣ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
| ||||||||
| code |
SOΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: social-history
| ||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. ele-1: All FHIR elements must have a @value or children
| ||||||||
| coding |
SOΣ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
| ||||||||
| system |
SOΣ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://snomed.info/sct
| ||||||||
| code |
SOΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: 441829007
| ||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about ele-1: All FHIR elements must have a @value or children
| ||||||||
| encounter |
SOΣ | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made ele-1: All FHIR elements must have a @value or children
| ||||||||
| effective[x] |
SOΣ | 1..1 | dateTime | Clinically relevant time/time-period for observation ele-1: All FHIR elements must have a @value or children
| ||||||||
| performer |
SOΣ | 0..* | Reference(AU Core Practitioner) | Who is responsible for the observation ele-1: All FHIR elements must have a @value or children
| ||||||||
| Slices for value[x] |
SOΣC | 1..1 | Cardiovascular disease risk represented as a percentage Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueRange |
Range | |||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result ele-1: All FHIR elements must have a @value or children
| ||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children
| ||||||||
| comparator |
?!SOΣ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
| value[x]:valueRange |
SOΣC | 0..1 | Range | Actual result ele-1: All FHIR elements must have a @value or children
| ||||||||
| low |
Σ | 0..1 | SimpleQuantity | Low limit ele-1: All FHIR elements must have a @value or children | ||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
| high |
Σ | 0..1 | SimpleQuantity | High limit ele-1: All FHIR elements must have a @value or children | ||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit ele-1: All FHIR elements must have a @value or children Fixed Value: %
| ||||||||
| interpretation |
SO | 1..1 | CodeableConcept | Cardiovascular disease risk category Binding: Aus CVD Risk Category (required) ele-1: All FHIR elements must have a @value or children
| ||||||||
| derivedFrom |
SOΣ | 0..* | Reference(QuestionnaireResponse) | Related measurements the observation is made from ele-1: All FHIR elements must have a @value or children
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | |
| Observation.interpretation | required | AusCVDRiskCategoryhttps://www.cvdcheck.org.au/fhir/ValueSet/AusCVDRiskCategory-1from this IG |
| Id | Grade | Path(s) | Details | Requirements |
| au-cvd-ro-01 | error | Observation.contained | A contained QuestionnaireResponse resource SHALL be present. : exists($this is QuestionnaireResponse) | |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
0..* | Observation | Cardiovascular disease risk assessment result in an Australia context | |||||||
| contained |
SOC | 0..* | Resource | Contained, inline Resources au-cvd-ro-01: A contained QuestionnaireResponse resource SHALL be present.
| ||||||
| status |
SO | 1..1 | code | registered | preliminary | final | amended + Fixed Value: final
| ||||||
| category |
SO | 1..* | CodeableConcept | Classification of type of observation
| ||||||
| coding |
SO | 1..* | Coding | Code defined by a terminology system
| ||||||
| system |
SO | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
| ||||||
| code |
SO | 1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history
| ||||||
| code |
SO | 1..1 | CodeableConcept | Type of observation (code / type)
| ||||||
| coding |
SO | 1..* | Coding | Code defined by a terminology system
| ||||||
| system |
SO | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
| ||||||
| code |
SO | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 441829007
| ||||||
| subject |
SO | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| ||||||
| encounter |
SO | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made
| ||||||
| effective[x] |
SO | 1..1 | dateTime | Clinically relevant time/time-period for observation
| ||||||
| performer |
SO | 0..* | Reference(AU Core Practitioner) | Who is responsible for the observation
| ||||||
| Slices for value[x] |
SO | 1..1 | Cardiovascular disease risk represented as a percentage Slice: Unordered, Open by type:$this
| |||||||
| valueQuantity |
Quantity | |||||||||
| valueRange |
Range | |||||||||
| value[x]:valueQuantity |
SO | 0..1 | Quantity | Actual result
| ||||||
| value |
SO | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||
| comparator |
SO | 0..1 | code | < | <= | >= | > - how to understand the value
| ||||||
| unit |
SO | 1..1 | string | Unit representation Fixed Value: %
| ||||||
| system |
SO | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| ||||||
| code |
SO | 1..1 | code | Coded form of the unit Fixed Value: %
| ||||||
| value[x]:valueRange |
SO | 0..1 | Range | Actual result
| ||||||
| low |
||||||||||
| value |
SO | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||
| unit |
SO | 1..1 | string | Unit representation Fixed Value: %
| ||||||
| system |
SO | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| ||||||
| code |
SO | 1..1 | code | Coded form of the unit Fixed Value: %
| ||||||
| high |
||||||||||
| value |
SO | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||
| unit |
SO | 1..1 | string | Unit representation Fixed Value: %
| ||||||
| system |
SO | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| ||||||
| code |
SO | 1..1 | code | Coded form of the unit Fixed Value: %
| ||||||
| interpretation |
SO | 1..1 | CodeableConcept | Cardiovascular disease risk category Binding: Aus CVD Risk Category (required)
| ||||||
| derivedFrom |
SO | 0..* | Reference(QuestionnaireResponse) | Related measurements the observation is made from
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.interpretation | required | AusCVDRiskCategoryhttps://www.cvdcheck.org.au/fhir/ValueSet/AusCVDRiskCategory-1from this IG |
| Id | Grade | Path(s) | Details | Requirements |
| au-cvd-ro-01 | error | Observation.contained | A contained QuestionnaireResponse resource SHALL be present. : exists($this is QuestionnaireResponse) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Cardiovascular disease risk assessment result in an Australia context obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||||||
| id |
Σ | 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 |
SOC | 0..* | Resource | Contained, inline Resources au-cvd-ro-01: A contained QuestionnaireResponse resource SHALL be present.
| ||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | ||||||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||||||
| status |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final
| ||||||||
| category |
SO | 1..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 1..* | Coding | Code defined by a terminology system
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| system |
SOΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
| ||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||
| code |
SOΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history
| ||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 1..* | Coding | Code defined by a terminology system
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| system |
SOΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
| ||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||
| code |
SOΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 441829007
| ||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| ||||||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||||||
| encounter |
SOΣ | 0..1 | Reference(AU Core Encounter) | Healthcare event during which this observation is made
| ||||||||
| effective[x] |
SOΣ | 1..1 | dateTime | Clinically relevant time/time-period for observation
| ||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||||||
| performer |
SOΣ | 0..* | Reference(AU Core Practitioner) | Who is responsible for the observation
| ||||||||
| Slices for value[x] |
SOΣC | 1..1 | Cardiovascular disease risk represented as a percentage Slice: Unordered, Closed by type:$this
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueRange |
Range | |||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||||
| comparator |
?!SOΣ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit Fixed Value: %
| ||||||||
| value[x]:valueRange |
SOΣC | 0..1 | Range | Actual result
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| low |
Σ | 0..1 | SimpleQuantity | Low limit | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit Fixed Value: %
| ||||||||
| high |
Σ | 0..1 | SimpleQuantity | High limit | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| value |
SOΣ | 1..1 | decimal | Numerical value (with implicit precision)
| ||||||||
| unit |
SOΣ | 1..1 | string | Unit representation Fixed Value: %
| ||||||||
| system |
SOΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit Fixed Value: %
| ||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||
| interpretation |
SO | 1..1 | CodeableConcept | Cardiovascular disease risk category Binding: Aus CVD Risk Category (required)
| ||||||||
| 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 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(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||||||
| derivedFrom |
SOΣ | 0..* | Reference(QuestionnaireResponse) | Related measurements the observation is made from
| ||||||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||||||
| 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 |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||||||
| value[x] |
Σ | 0..1 | Actual component result | |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| dataAbsentReason |
C | 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 | URI | |||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | required | AusCVDRiskCategoryhttps://www.cvdcheck.org.au/fhir/ValueSet/AusCVDRiskCategory-1from this IG | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-cvd-ro-01 | error | Observation.contained | A contained QuestionnaireResponse resource SHALL be present. : exists($this is QuestionnaireResponse) | |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
This structure is derived from Observation
Summary
Mandatory: 11 elements(12 nested mandatory elements)
Must-Support: 32 elements
Fixed: 14 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron