Clinical Document Architecture with Australian Schema
1.0.0 - current
Clinical Document Architecture with Australian Schema
1.0.0 - current
Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2024-08-29 |
JSON representation of the au-Entity logical model.
{
"resourceType" : "StructureDefinition",
"id" : "au-Entity",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>A physical thing, group of physical things or an organization capable of participating in\n Acts while in a role.</p>\n <p>An entity is a physical object that has, had or will have existence. The only exception to\n this is Organization, which while not having a physical presence, fulfills the other\n characteristics of an Entity. Entity stipulates the thing itself, not the Roles it may play:\n the Role of Patient, e.g., is played by the Person Entity.</p>\n <p>Living subjects (including human beings), organizations, materials, places and their\n specializations.</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" : "entity"
},
{
"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-Entity",
"version" : "1.0.0",
"name" : "au-Entity",
"title" : "ADHA Entity (CDA Class)",
"status" : "active",
"experimental" : false,
"date" : "2024-08-29T09:46:41+10:00",
"publisher" : "Australian Digital Health Agency",
"contact" : [
{
"name" : "Australian Digital Health Agency",
"telecom" : [
{
"system" : "email",
"value" : "mailto:[email protected]"
}
]
}
],
"description" : "**Australian adaptation of the [HL7 International CDA Entity class]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Entity.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/Entity",
"baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "Entity",
"path" : "Entity",
"short" : "Australian adaptation of the HL7 International CDA Entity 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" : "Entity.nullFlavor",
"path" : "Entity.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" : "Entity.realmCode",
"path" : "Entity.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" : "Entity.typeId",
"path" : "Entity.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" : "Entity.typeId.nullFlavor",
"path" : "Entity.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" : "Entity.typeId.assigningAuthorityName",
"path" : "Entity.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" : "Entity.typeId.displayable",
"path" : "Entity.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" : "Entity.typeId.root",
"path" : "Entity.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" : "Entity.typeId.extension",
"path" : "Entity.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" : "Entity.templateId",
"path" : "Entity.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" : "Entity.classCode",
"path" : "Entity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entity.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode" : "ENT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassRoot"
}
},
{
"id" : "Entity.determinerCode",
"path" : "Entity.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entity.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "Entity.id",
"path" : "Entity.id",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Entity.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Entity.code",
"path" : "Entity.code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode"
}
},
{
"id" : "Entity.name",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.name",
"short" : "ADHA CDA extension to represent entity's name",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Entity.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationName",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationName"
]
}
]
},
{
"id" : "Entity.desc",
"path" : "Entity.desc",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entity.desc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "Entity.telecom",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.telecom",
"short" : "ADHA CDA extension to represent entity's telecommunication details",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Entity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom"
]
}
]
},
{
"id" : "Entity.addr",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.addr",
"short" : "ADHA CDA extension to represent entity's address",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Entity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Address",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Address"
]
}
]
},
{
"id" : "Entity.asOrganizationPartOf",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.asOrganizationPartOf",
"short" : "ADHA CDA extension to represent a which organisation the entity is part of",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Entity.asOrganizationPartOf",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationPartOf",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationPartOf"
]
}
]
},
{
"id" : "Entity.asEntityIdentifier",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.asEntityIdentifier",
"short" : "ADHA CDA extension to represent a entity's identifier",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Entity.asEntityIdentifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier"
]
}
]
},
{
"id" : "Entity.asQualifiedEntity",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.asQualifiedEntity",
"short" : "ADHA CDA extension to represent a qualified entity",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entity.asQualifiedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/asQualifiedEntity",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/asQualifiedEntity"
]
}
]
},
{
"id" : "Entity.personalRelationship",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.personalRelationship",
"short" : "ADHA CDA extension to represent personal relationship of the entity",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Entity.personalRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship"
]
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Entity",
"path" : "Entity",
"short" : "Australian adaptation of the HL7 International CDA Entity class",
"min" : 1,
"max" : "1"
},
{
"id" : "Entity.classCode",
"path" : "Entity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode" : "ENT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassRoot"
}
},
{
"id" : "Entity.determinerCode",
"path" : "Entity.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "Entity.id",
"path" : "Entity.id",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Entity.code",
"path" : "Entity.code",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode"
}
},
{
"id" : "Entity.name",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.name",
"short" : "ADHA CDA extension to represent entity's name",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationName",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationName"
]
}
]
},
{
"id" : "Entity.desc",
"path" : "Entity.desc",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "Entity.telecom",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.telecom",
"short" : "ADHA CDA extension to represent entity's telecommunication details",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom"
]
}
]
},
{
"id" : "Entity.addr",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.addr",
"short" : "ADHA CDA extension to represent entity's address",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Address",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Address"
]
}
]
},
{
"id" : "Entity.asOrganizationPartOf",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.asOrganizationPartOf",
"short" : "ADHA CDA extension to represent a which organisation the entity is part of",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationPartOf",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationPartOf"
]
}
]
},
{
"id" : "Entity.asEntityIdentifier",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.asEntityIdentifier",
"short" : "ADHA CDA extension to represent a entity's identifier",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier"
]
}
]
},
{
"id" : "Entity.asQualifiedEntity",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.asQualifiedEntity",
"short" : "ADHA CDA extension to represent a qualified entity",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/asQualifiedEntity",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/asQualifiedEntity"
]
}
]
},
{
"id" : "Entity.personalRelationship",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
}
],
"path" : "Entity.personalRelationship",
"short" : "ADHA CDA extension to represent personal relationship of the entity",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship",
"profile" : [
🔗 "http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship"
]
}
]
}
]
}
}
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-08-29
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
