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 |
TTL representation of the au-PersonName logical model.
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:StructureDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "au-PersonName"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).</p>\n </div>"
] ; #
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/logical-target"^^xsd:anyURI ] ;
fhir:value [
a fhir:boolean ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/data-absent-reason"^^xsd:anyURI ] ;
fhir:value [ fhir:v "not-applicable" ] ] ) ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace"^^xsd:anyURI ] ;
fhir:value [ fhir:v "urn:hl7-org:v3"^^xsd:anyURI ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/xml-name"^^xsd:anyURI ] ;
fhir:value [ fhir:v "name" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/logical-container"^^xsd:anyURI ] ;
fhir:value [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"^^xsd:anyURI ]
] ) ; #
fhir:url [ fhir:v "http://ns.electronichealth.net.au/cda/StructureDefinition/au-PersonName"^^xsd:anyURI] ; #
fhir:version [ fhir:v "1.0.0"] ; #
fhir:name [ fhir:v "au-PersonName"] ; #
fhir:title [ fhir:v "ADHA PN: PersonName (V3 Data Type)"] ; #
fhir:status [ fhir:v "active"] ; #
fhir:experimental [ fhir:v "false"^^xsd:boolean] ; #
fhir:date [ fhir:v "2024-12-18T05:40:48+00:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "Australian Digital Health Agency"] ; #
fhir:contact ( [
fhir:name [ fhir:v "Australian Digital Health Agency" ] ;
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "mailto:help@digitalhealth.gov.au" ] ] )
] ) ; #
fhir:description [ fhir:v "**Australian adaptation of the [HL7 International CDA Person Name dataType]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-PN.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"] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "AU" ] ] )
] ) ; #
fhir:copyright [ fhir:v "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/)."] ; #
fhir:fhirVersion [ fhir:v "5.0.0"] ; #
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:uri [ fhir:v "http://hl7.org/v3"^^xsd:anyURI ] ;
fhir:name [ fhir:v "RIM Mapping" ]
] ) ; #
fhir:kind [ fhir:v "logical"] ; #
fhir:abstract [ fhir:v "false"^^xsd:boolean] ; #
fhir:type [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/PN"^^xsd:anyURI] ; #
fhir:baseDefinition [
fhir:v "http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntityName"^^xsd:anyURI ;
fhir:link <http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntityName>
] ; #
fhir:derivation [ fhir:v "specialization"] ; #
fhir:snapshot [
( fhir:element [
fhir:id [ fhir:v "PN" ] ;
fhir:path [ fhir:v "PN" ] ;
fhir:short [ fhir:v "Australian adaptation of the HL7 International EntityName (EN) dataType" ] ;
fhir:definition [ fhir:v "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status)." ] ;
fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "Base" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ] ;
( fhir:constraint [
fhir:key [ fhir:v "pn-no-ls" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "No PN name part may have a qualifier of LS." ] ;
fhir:expression [ fhir:v "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()" ] ] ) ;
fhir:isModifier [ fhir:v "false"^^xsd:boolean ] ;
( fhir:mapping [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ] ] ) ] [
fhir:id [ fhir:v "PN.nullFlavor" ] ;
fhir:path [ fhir:v "PN.nullFlavor" ] ;
( fhir:representation [ fhir:v "xmlAttr" ] ) ;
fhir:label [ fhir:v "Exceptional Value Detail" ] ;
fhir:definition [ fhir:v "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing." ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "ANY.nullFlavor" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "1" ] ] ;
( fhir:type [
fhir:code [ fhir:v "code"^^xsd:anyURI ] ;
( fhir:profile [
fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"^^xsd:anyURI ;
fhir:link <http://hl7.org/cda/stds/core/StructureDefinition/cs-simple> ] ) ] ) ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"^^xsd:anyURI ;
fhir:link <http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor> ] ] ] [
fhir:id [ fhir:v "PN.use" ] ;
fhir:path [ fhir:v "PN.use" ] ;
( fhir:representation [ fhir:v "xmlAttr" ] ) ;
fhir:label [ fhir:v "Use Code" ] ;
fhir:definition [ fhir:v "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" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "EN.use" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ] ;
( fhir:type [
fhir:code [ fhir:v "code"^^xsd:anyURI ] ;
( fhir:profile [
fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"^^xsd:anyURI ;
fhir:link <http://hl7.org/cda/stds/core/StructureDefinition/cs-simple> ] ) ] ) ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse"^^xsd:anyURI ;
fhir:link <http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse> ] ] ] [
fhir:id [ fhir:v "PN.item" ] ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group"^^xsd:anyURI ] ;
fhir:value [ fhir:v "true"^^xsd:boolean ] ] ) ;
fhir:path [ fhir:v "PN.item" ] ;
fhir:definition [ fhir:v "A series of items that constitute the name." ] ;
fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "EN.item" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ] ;
( fhir:type [
fhir:code [ fhir:v "http://hl7.org/fhir/StructureDefinition/Base"^^xsd:anyURI ] ] ) ;
( fhir:constraint [
fhir:key [ fhir:v "EN-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "Can only have only one of the possible item elements in each choice" ] ;
fhir:expression [ fhir:v "(delimiter | family | given | prefix | suffix | xmlText).count() = 1" ] ;
fhir:source [
fhir:v "http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntityName"^^xsd:anyURI ;
fhir:link <http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntityName> ] ] ) ] [
fhir:id [ fhir:v "PN.item.delimiter" ] ;
fhir:path [ fhir:v "PN.item.delimiter" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "EN.item.delimiter" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ] ;
( fhir:type [
fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"^^xsd:anyURI ] ] ) ] [
fhir:id [ fhir:v "PN.item.family" ] ;
fhir:path [ fhir:v "PN.item.family" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "EN.item.family" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ] ;
( fhir:type [
fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"^^xsd:anyURI ] ] ) ] [
fhir:id [ fhir:v "PN.item.given" ] ;
fhir:path [ fhir:v "PN.item.given" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "EN.item.given" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ] ;
( fhir:type [
fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"^^xsd:anyURI ] ] ) ] [
fhir:id [ fhir:v "PN.item.prefix" ] ;
fhir:path [ fhir:v "PN.item.prefix" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "EN.item.prefix" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ] ;
( fhir:type [
fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"^^xsd:anyURI ] ] ) ] [
fhir:id [ fhir:v "PN.item.suffix" ] ;
fhir:path [ fhir:v "PN.item.suffix" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "EN.item.suffix" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ] ;
( fhir:type [
fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"^^xsd:anyURI ] ] ) ] [
fhir:id [ fhir:v "PN.item.xmlText" ] ;
fhir:path [ fhir:v "PN.item.xmlText" ] ;
( fhir:representation [ fhir:v "xmlText" ] ) ;
fhir:short [ fhir:v "Allows for mixed text content" ] ;
fhir:comment [ fhir:v "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance." ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "EN.item.xmlText" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "1" ] ] ;
( fhir:type [
fhir:code [ fhir:v "string"^^xsd:anyURI ] ;
( fhir:profile [
fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"^^xsd:anyURI ;
fhir:link <http://hl7.org/cda/stds/core/StructureDefinition/st-simple> ] ) ] ) ] [
fhir:id [ fhir:v "PN.validTime" ] ;
fhir:path [ fhir:v "PN.validTime" ] ;
fhir:label [ fhir:v "Valid Time" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "EN.validTime" ] ;
fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "1" ] ] ;
( fhir:type [
fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"^^xsd:anyURI ] ] ) ] )
] ; #
fhir:differential [
( fhir:element [
fhir:id [ fhir:v "PN" ] ;
fhir:path [ fhir:v "PN" ] ;
fhir:definition [ fhir:v "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status)." ] ;
( fhir:constraint [
fhir:key [ fhir:v "pn-no-ls" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "No PN name part may have a qualifier of LS." ] ;
fhir:expression [ fhir:v "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()" ] ] ) ] [
fhir:id [ fhir:v "PN.item" ] ;
fhir:path [ fhir:v "PN.item" ] ;
fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ;
fhir:max [ fhir:v "*" ] ] )
] . #
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
Publisher: Australian Digital Health Agency | ABN: 84 425 496 912, Level 25, 175 Liverpool Street, Sydney, NSW 2000 | Phone: 1300 901 001 | Email: help@digitalhealth.gov.au | https://www.digitalhealth.gov.au | Privacy policy | Terms of Use
