Clinical Document Architecture with Australian Schema
1.0.0 - current
Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions
| Active as of 2024-12-18 |
Definitions for the Observation logical model.
Guidance on how to interpret the contents of this table can be found here
Guidance on how to interpret the contents of this table can be found here
| 0. Observation | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| Logical Container | ADHA ClinicalDocument (CDA Class) |
| Validation | Instance of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Observation.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 4. Observation.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 6. Observation.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 8. Observation.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 10. Observation.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 12. Observation.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 14. Observation.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 16. Observation.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 18. Observation.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 20. Observation.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CDAActClassObservation (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 22. Observation.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from XActMoodDocumentObservation (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 24. Observation.negationInd | |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 26. Observation.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..*1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IIid |
| Is Modifier | false |
| 28. Observation.code | |
| Definition | Describes what was observed. Sometimes this is called the observation "name". |
| Short | Type of observation (code / type) |
| Comments | All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
| Control | 1..1 This element is affected by the following invariants: obs-7 |
| Binding | For example codes, see ObservationTypehttp://hl7.org/fhir/ValueSet/observation-codes (example to http://terminology.hl7.org/ValueSet/v3-ObservationType) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept |
| Is Modifier | false |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
| Alternate Names | Name |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. Observation.derivationExpr | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
| 32. Observation.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EDNarrative |
| Is Modifier | false |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. Observation.statusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 36. Observation.effectiveTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 38. Observation.priorityCode | |
| Control | 0..1 |
| Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 40. Observation.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
| 42. Observation.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 44. Observation.value | |
| Control | 0..* |
| Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/CO, http://hl7.org/cda/stds/core/StructureDefinition/SC, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| 46. Observation.interpretationCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from CDAObservationInterpretation (required to http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 48. Observation.methodCode | |
| Control | 0..* |
| Binding | For example codes, see ObservationMethod (example to http://terminology.hl7.org/ValueSet/v3-ObservationMethod) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 50. Observation.targetSiteCode | |
| Definition | Drawn from concept domain ActSite |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 52. Observation.subject | |
| Definition | The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the |
| Short | Who and/or what the observation is about |
| Comments | One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubjectReference(Patient, Group, Device, Location, Organization, Procedure, Practitioner, Medication, Substance, BiologicallyDerivedProduct, NutritionProduct) |
| Is Modifier | false |
| Requirements | Observations have no value if you don't know who or what they're about. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. Observation.specimen | |
| Definition | The specimen that was used when this observation was made. |
| Short | Specimen used for this observation |
| Comments | Should only be used if not implicit in code found in |
| Control | 0..*1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SpecimenReference(Specimen, Group) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) obs-9: If Observation.specimen is a reference to Group, the group can only have specimens ((reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen)) |
| 56. Observation.performer | |
| Definition | Who was responsible for asserting the observed value as "true". |
| Short | Who is responsible for the observation |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, RelatedPerson) |
| Is Modifier | false |
| Requirements | May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Observation.author | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 60. Observation.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 62. Observation.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 64. Observation.entryRelationship | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 66. Observation.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 68. Observation.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 70. Observation.sdtcPrecondition2 | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2 |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2. |
| 72. Observation.referenceRange | |
| Definition | Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified. Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two |
| Short | Provides guide for interpretation |
| Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRootBackboneElement |
| Is Modifier | false |
| Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) obs-3: Must have at least a low or a high or text (low.exists() or high.exists() or text.exists()) |
| 74. Observation.referenceRange.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 76. Observation.referenceRange.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 78. Observation.referenceRange.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 80. Observation.referenceRange.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 82. Observation.referenceRange.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 84. Observation.referenceRange.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 86. Observation.referenceRange.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 88. Observation.referenceRange.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 90. Observation.referenceRange.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 92. Observation.referenceRange.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDAActRelationshipType (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | REFV |
| 94. Observation.referenceRange.observationRange | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange |
| 96. Observation.sdtcInFulfillmentOf1 | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1 |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1. |
Guidance on how to interpret the contents of this table can be found here
| 0. Observation | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| Logical Container | ADHA ClinicalDocument (CDA Class) |
| Validation | Instance of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Observation.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 4. Observation.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 6. Observation.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 8. Observation.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 10. Observation.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 12. Observation.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 14. Observation.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 16. Observation.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 18. Observation.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 20. Observation.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CDAActClassObservation (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 22. Observation.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from XActMoodDocumentObservation (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 24. Observation.negationInd | |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 26. Observation.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 28. Observation.code | |
| Control | 1..1 |
| Binding | For example codes, see ObservationType (example to http://terminology.hl7.org/ValueSet/v3-ObservationType) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| 30. Observation.derivationExpr | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
| 32. Observation.text | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| 34. Observation.statusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 36. Observation.effectiveTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 38. Observation.priorityCode | |
| Control | 0..1 |
| Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 40. Observation.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
| 42. Observation.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 44. Observation.value | |
| Control | 0..* |
| Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/CO, http://hl7.org/cda/stds/core/StructureDefinition/SC, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| 46. Observation.interpretationCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from CDAObservationInterpretation (required to http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 48. Observation.methodCode | |
| Control | 0..* |
| Binding | For example codes, see ObservationMethod (example to http://terminology.hl7.org/ValueSet/v3-ObservationMethod) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 50. Observation.targetSiteCode | |
| Definition | Drawn from concept domain ActSite |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 52. Observation.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 54. Observation.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 56. Observation.performer | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 58. Observation.author | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 60. Observation.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 62. Observation.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 64. Observation.entryRelationship | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 66. Observation.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 68. Observation.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 70. Observation.sdtcPrecondition2 | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2 |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2. |
| 72. Observation.referenceRange | |
| Definition | Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| 74. Observation.referenceRange.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 76. Observation.referenceRange.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 78. Observation.referenceRange.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 80. Observation.referenceRange.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 82. Observation.referenceRange.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 84. Observation.referenceRange.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 86. Observation.referenceRange.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 88. Observation.referenceRange.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 90. Observation.referenceRange.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 92. Observation.referenceRange.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDAActRelationshipType (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | REFV |
| 94. Observation.referenceRange.observationRange | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange |
| 96. Observation.sdtcInFulfillmentOf1 | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1 |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1. |
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
