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 |
JSON representation of the CE logical model.
{
"resourceType" : "StructureDefinition",
"id" : "CE",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>Coded data, consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist.</p>\n </div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "not-applicable"
}
]
}
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:v3"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode" : "can-bind"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-binding-style",
"valueCode" : "CDA"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
],
"url" : "http://hl7.org/cda/stds/core/StructureDefinition/CE",
"version" : "1.0.0",
"name" : "CE",
"title" : "CE: CodedWithEquivalents (V3 Data Type)",
"status" : "active",
"experimental" : false,
"date" : "2024-12-18T05:40:48+00:00",
"publisher" : "HL7",
"description" : "Coded data that consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist.",
"fhirVersion" : "5.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://hl7.org/cda/stds/core/StructureDefinition/CE",
"baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/CD",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "CE",
"path" : "CE",
"short" : "Base for all types and resources",
"definition" : "Coded data, consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "CE.nullFlavor",
"path" : "CE.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "CE.code",
"path" : "CE.code",
"representation" : [
"xmlAttr"
],
"label" : "Code",
"definition" : "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "CE.codeSystem",
"path" : "CE.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/uuid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
]
},
{
"id" : "CE.codeSystemName",
"path" : "CE.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "CE.codeSystemVersion",
"path" : "CE.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "CE.displayName",
"path" : "CE.displayName",
"representation" : [
"xmlAttr"
],
"label" : "Display Name",
"definition" : "A name or title for the code, under which the sending system shows the code value to its users.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "CE.sdtcValueSet",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSet"
}
],
"path" : "CE.sdtcValueSet",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id" : "CE.sdtcValueSetVersion",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSetVersion"
}
],
"path" : "CE.sdtcValueSetVersion",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.sdtcValueSetVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "CE.originalText",
"path" : "CE.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "CE.qualifier",
"path" : "CE.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.qualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id" : "CE.translation",
"path" : "CE.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "CE",
"path" : "CE",
"definition" : "Coded data, consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist.",
"min" : 1,
"max" : "*"
},
{
"id" : "CE.qualifier",
"path" : "CE.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
}
]
}
}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
