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-11-22 |
JSON representation of the ON logical model.
{
"resourceType" : "StructureDefinition",
"id" : "ON",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>A name for an organization. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for organization name values are "Health Level Seven, Inc.", "Hospital", etc. An organization name may be as simple as a character string or may consist of several person name parts, such as, "Health Level 7", "Inc.". ON differs from EN because certain person related name parts are not possible.</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/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
],
"url" : "http://hl7.org/cda/stds/core/StructureDefinition/ON",
"version" : "1.0.0",
"name" : "ON",
"title" : "ON: OrganizationName (V3 Data Type)",
"status" : "active",
"experimental" : false,
"date" : "2024-11-22T03:02:41+00:00",
"publisher" : "HL7",
"description" : "A name for an organization. A sequence of name parts. Examples for organization name values are \"Health Level Seven, Inc.\", \"Hospital\", etc. An organization name may be as simple as a character string or may consist of several person name parts, such as, \"Health Level 7\", \"Inc.\". ON differs from EN because certain person related name parts are not possible.",
"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/ON",
"baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/EN",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "ON",
"path" : "ON",
"short" : "Base for all types and resources",
"definition" : "A name for an organization. A sequence of name parts. Examples for organization name values are \"Health Level Seven, Inc.\", \"Hospital\", etc. An organization name may be as simple as a character string or may consist of several person name parts, such as, \"Health Level 7\", \"Inc.\". ON differs from EN because certain person related name parts are not possible.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ON.nullFlavor",
"path" : "ON.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" : "ON.use",
"path" : "ON.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EN.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse"
}
},
{
"id" : "ON.item",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group",
"valueBoolean" : true
}
],
"path" : "ON.item",
"definition" : "A series of items that constitute the name.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EN.item",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/StructureDefinition/Base"
}
],
"constraint" : [
{
"key" : "EN-1",
"severity" : "error",
"human" : "Can only have only one of the possible item elements in each choice",
"expression" : "(delimiter | family | given | prefix | suffix | xmlText).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/EN"
}
]
},
{
"id" : "ON.item.delimiter",
"path" : "ON.item.delimiter",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EN.item.delimiter",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id" : "ON.item.family",
"path" : "ON.item.family",
"min" : 0,
"max" : "0",
"base" : {
"path" : "EN.item.family",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id" : "ON.item.given",
"path" : "ON.item.given",
"min" : 0,
"max" : "0",
"base" : {
"path" : "EN.item.given",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id" : "ON.item.prefix",
"path" : "ON.item.prefix",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EN.item.prefix",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id" : "ON.item.suffix",
"path" : "ON.item.suffix",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EN.item.suffix",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id" : "ON.item.xmlText",
"path" : "ON.item.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EN.item.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ON.validTime",
"path" : "ON.validTime",
"label" : "Valid Time",
"definition" : "An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EN.validTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "ON",
"path" : "ON",
"definition" : "A name for an organization. A sequence of name parts. Examples for organization name values are \"Health Level Seven, Inc.\", \"Hospital\", etc. An organization name may be as simple as a character string or may consist of several person name parts, such as, \"Health Level 7\", \"Inc.\". ON differs from EN because certain person related name parts are not possible.",
"min" : 1,
"max" : "*"
},
{
"id" : "ON.item.family",
"path" : "ON.item.family",
"max" : "0"
},
{
"id" : "ON.item.given",
"path" : "ON.item.given",
"max" : "0"
}
]
}
}IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-11-22
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
