FHIR IG Statistics: StructureDefinition/au-EntityName
| Package | au.digitalhealth.cda.schema |
| Type | StructureDefinition |
| Id | au-EntityName |
| FHIR Version | R5 |
| Source | http://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-au-EntityName.html |
| URL | http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntityName |
| Version | 1.0.0 |
| Status | active |
| Date | 2025-07-13T21:39:05+00:00 |
| Name | au-EntityName |
| Title | ADHA EN: EntityName (V3 Data Type) |
| Realm | au |
| Authority | national |
| Description | **Australian adaptation of the [HL7 International CDA Entity Name dataType]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-EN.html)**.
This 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 |
| 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/). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EN |
| Kind | logical |
Resources that use this resource
Resources that this resource uses
| StructureDefinition |
| ANY | ANY: DataValue (V3 Data Type) |
| ENXP | ENXP: Entity Name Part (V3 Data Type) |
| IVL-TS | IVL_TS: Interval (V3 Data Type) |
| cs-simple | cs: Coded Simple Value |
| st-simple | st: Character String |
Narrative
Note: links and images are rebased to the (stated) source
A name for a person, organization, place or thing. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for entity name values are "Jim Bob Walton, Jr.", "Health Level Seven, Inc.", "Lake Tahoe", etc. An entity name may be as simple as a character string or may consist of several entity name parts, such as, "Jim", "Bob", "Walton", and "Jr.", "Health Level Seven" and "Inc.", "Lake" and "Tahoe".
Source
{
"resourceType": "StructureDefinition",
"id": "au-EntityName",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"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://ns.electronichealth.net.au/cda/StructureDefinition/au-EntityName",
"version": "1.0.0",
"name": "au-EntityName",
"title": "ADHA EN: EntityName (V3 Data Type)",
"status": "active",
"experimental": false,
"date": "2025-07-13T21:39:05+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 Entity Name dataType]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-EN.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/EN",
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/ANY",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "1.0.0"
}
],
"element": [
{
"id": "EN",
"path": "EN",
"short": "Australian adaptation of the HL7 International EntityName (EN) dataType",
"definition": "A name for a person, organization, place or thing. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for entity name values are \"Jim Bob Walton, Jr.\", \"Health Level Seven, Inc.\", \"Lake Tahoe\", etc. An entity name may be as simple as a character string or may consist of several entity name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\", \"Health Level Seven\" and \"Inc.\", \"Lake\" and \"Tahoe\".",
"min": 1,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EN.nullFlavor",
"path": "EN.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": "EN.use",
"path": "EN.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://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse"
}
},
{
"id": "EN.item",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group",
"valueBoolean": true
}
],
"path": "EN.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"
}
]
},
{
"id": "EN.item.delimiter",
"path": "EN.item.delimiter",
"min": 0,
"max": "*",
"base": {
"path": "EN.item.delimiter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "EN.item.family",
"path": "EN.item.family",
"min": 0,
"max": "*",
"base": {
"path": "EN.item.family",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "EN.item.given",
"path": "EN.item.given",
"min": 0,
"max": "*",
"base": {
"path": "EN.item.given",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "EN.item.prefix",
"path": "EN.item.prefix",
"min": 0,
"max": "*",
"base": {
"path": "EN.item.prefix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "EN.item.suffix",
"path": "EN.item.suffix",
"min": 0,
"max": "*",
"base": {
"path": "EN.item.suffix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "EN.item.xmlText",
"path": "EN.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": "EN.validTime",
"path": "EN.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": "EN",
"path": "EN",
"short": "Australian adaptation of the HL7 International EntityName (EN) dataType",
"definition": "A name for a person, organization, place or thing. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for entity name values are \"Jim Bob Walton, Jr.\", \"Health Level Seven, Inc.\", \"Lake Tahoe\", etc. An entity name may be as simple as a character string or may consist of several entity name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\", \"Health Level Seven\" and \"Inc.\", \"Lake\" and \"Tahoe\".",
"min": 1,
"max": "*"
},
{
"id": "EN.use",
"path": "EN.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": "*",
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse"
}
},
{
"id": "EN.item",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group",
"valueBoolean": true
}
],
"path": "EN.item",
"definition": "A series of items that constitute the name.",
"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"
}
]
},
{
"id": "EN.item.delimiter",
"path": "EN.item.delimiter",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "EN.item.family",
"path": "EN.item.family",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "EN.item.given",
"path": "EN.item.given",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "EN.item.prefix",
"path": "EN.item.prefix",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "EN.item.suffix",
"path": "EN.item.suffix",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "EN.item.xmlText",
"path": "EN.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",
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "EN.validTime",
"path": "EN.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",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}
]
}
]
}
}
FHIR