Clinical Document Architecture with Australian Schema
0.1.0 - ci-build
Clinical Document Architecture with Australian Schema
0.1.0 - ci-build
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 0.1.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-10-13 |
JSON representation of the au-languageCommunication logical model.
{
"resourceType" : "StructureDefinition",
"id" : "au-languageCommunication",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>The language communication capabilities of an Entity.</p>\n <p>While it may seem on the surface that this class would be restricted in usage to only the LivingSubject subtypes, Devices also have the ability to communicate, such as automated telephony devices that transmit patient information to live operators on a triage line or provide automated laboratory results to clinicians.</p>\n <p>A patient who originally came from Mexico may have fluent language capabilities to speak, read and write in Spanish, and rudimentary capabilities in English. A person from Russia may have the capability to communicate equally well in spoken language in Russian, Armenian or Ukrainian, and a preference to speak in Armenian.</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/xml-name",
"valueString" : "languageCommunication"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri" : "cda"
}
],
"url" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-languageCommunication",
"version" : "0.1.0",
"name" : "au-languageCommunication",
"title" : "ADHA LanguageCommunication (CDA Class)",
"status" : "active",
"experimental" : false,
"date" : "2024-10-13T23:51:04+00:00",
"publisher" : "Australian Digital Health Agency",
"contact" : [
{
"name" : "Australian Digital Health Agency",
"telecom" : [
{
"system" : "email",
"value" : "mailto:help@digitalhealth.gov.au"
}
]
}
],
"description" : "**Australian adaptation of the [HL7 International CDA LanguageCommunication class]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-LanguageCommunication.html)**. \n\nThis is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "AU"
}
]
}
],
"copyright" : "Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/).",
"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/LanguageCommunication",
"baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "LanguageCommunication",
"path" : "LanguageCommunication",
"short" : "Australian adaptation of the HL7 International CDA LanguageCommunication class",
"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.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "LanguageCommunication.nullFlavor",
"path" : "LanguageCommunication.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" : "LanguageCommunication.realmCode",
"path" : "LanguageCommunication.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",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "LanguageCommunication.typeId",
"path" : "LanguageCommunication.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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "LanguageCommunication.typeId.nullFlavor",
"path" : "LanguageCommunication.typeId.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" : "LanguageCommunication.typeId.assigningAuthorityName",
"path" : "LanguageCommunication.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "LanguageCommunication.typeId.displayable",
"path" : "LanguageCommunication.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "LanguageCommunication.typeId.root",
"path" : "LanguageCommunication.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"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"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "LanguageCommunication.typeId.extension",
"path" : "LanguageCommunication.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "LanguageCommunication.templateId",
"path" : "LanguageCommunication.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",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "LanguageCommunication.languageCode",
"path" : "LanguageCommunication.languageCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.languageCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id" : "LanguageCommunication.modeCode",
"path" : "LanguageCommunication.modeCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.modeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode"
}
},
{
"id" : "LanguageCommunication.proficiencyLevelCode",
"path" : "LanguageCommunication.proficiencyLevelCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.proficiencyLevelCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency"
}
},
{
"id" : "LanguageCommunication.preferenceInd",
"path" : "LanguageCommunication.preferenceInd",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.preferenceInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id" : "LanguageCommunication.interpreterRequiredInd",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "LanguageCommunication.interpreterRequiredInd",
"short" : "ADHA CDA extension to represent if an interpreter is required",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.interpreterRequiredInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "LanguageCommunication",
"path" : "LanguageCommunication",
"short" : "Australian adaptation of the HL7 International CDA LanguageCommunication class",
"min" : 1,
"max" : "1"
},
{
"id" : "LanguageCommunication.languageCode",
"path" : "LanguageCommunication.languageCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id" : "LanguageCommunication.modeCode",
"path" : "LanguageCommunication.modeCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode"
}
},
{
"id" : "LanguageCommunication.proficiencyLevelCode",
"path" : "LanguageCommunication.proficiencyLevelCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency"
}
},
{
"id" : "LanguageCommunication.preferenceInd",
"path" : "LanguageCommunication.preferenceInd",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id" : "LanguageCommunication.interpreterRequiredInd",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "LanguageCommunication.interpreterRequiredInd",
"short" : "ADHA CDA extension to represent if an interpreter is required",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
}
]
}
}
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#0.1.0 based on FHIR 5.0.0. Generated 2024-10-13
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
