cnd-patient
type: StructureDefinition
node role: treeRoot
id:
  v: cnd-patient
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition cnd-patient Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Patient <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( inv-01-family-name-length-not-absent, inv-02-given-name-length-if-not-absent )">C 0..* AUCorePatient Clinical Note Document Patient Constraints: inv-01-family-name-length-not-absent, inv-02-given-name-length-if-not-absent #xD; extension 2..* Extension Extension #xD; Slices for extension Content/Rules for all slices #xD; extension:indigenousStatus 1..1 AustralianIndigenousStatus Indigenous status #xD; extension:genderIdentity 1..* PGenderIdentity(5.3.0) The individual's gender identity #xD; extension:sexParameterForClinicalUse S 0..* PatSexParameterForClinicalUse(5.3.0) A context-specific sex parameter for clinical use #xD; extension:informalCarer 0..1 (Complex) Patient's informal carer information URL: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer #xD; Slices for name 1..* HumanName A name associated with the patient Slice: Unordered, Open by value:use #xD; name:All Slices Content/Rules for all slices #xD; family 1..1 string Patient's family name #xD; given 0..* string Patient's given name #xD; name:preferredName 0..1 HumanName A name associated with the patient #xD; use 1..1 code usual | official | temp | nickname | anonymous | old | maiden Fixed Value: usual #xD; family 1..1 string Patient's family name #xD; birthDate 1..1 date Patient's date of birth #xD; Slices for extension Content/Rules for all slices #xD; extension:accuracyIndicator 0..1 DateAccuracyIndicator Patient's date of birth…
url:
  v: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-patient
version:
  v: 26.0.0
name:
  v: CND_Patient
title:
  v: CND Patient
status:
  v: active
date:
  v: 2026-06-16T09:55:11+10:00
publisher:
  v: Australian Digital Health Agency
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: url
    value:
      v: https://www.digitalhealth.gov.au
  telecom:
    system:
      v: email
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: This profile constrains [AU Core Patient](https://hl7.org.au/fhir/core/StructureDefinition-au-core-patient.html) to meet the requirements of this Implementation Guide for a patient or consumer. Implementers are highly encouraged to review AU Core Patient profile before using this profile. This profile defines a patient or a consumer of Clinical Note Document.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: AU
    display:
      v: Australia
purpose:
  v: This profile defines patient identification and demographic requirements for a Clinical Note Document in Australia, ensuring consistent capture of consumer details including name and identity information for clinical note exchange across healthcare settings.
copyright:
  v: 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 version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: cda
  uri:
    v: http://hl7.org/v3/cda
  name:
    v: CDA (R2)
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
  name:
    v: FiveWs Pattern Mapping
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: loinc
  uri:
    v: http://loinc.org
  name:
    v: LOINC code for the element
kind:
  v: resource
abstract:
  v: false
type:
  v: Patient
base definition:
  v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
  link: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 2.0.0
  element:
    id:
      v: Patient
    path:
      v: Patient
    short:
      v: Clinical Note Document Patient
    definition:
      v: Demographics and other administrative information about an individual receiving care or other health-related services.
    alias:
      v: SubjectOfCare Client Resident
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Patient
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      xpath:
        v: not(parent::f:contained and f:contained)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
      expression:
        v: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
      xpath:
        v: not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:security))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      extension:
        value: boolean
      extension:
        value: markdown
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      xpath:
        v: exists(f:text/h:div)

boolean
v: true

markdown
v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

key:
  v: inv-pat-0
severity:
  v: error
human:
  v: If present, birth time's date shall be the birth date
expression:
  v: birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString()
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-patient
  link: http://hl7.org.au/fhir/StructureDefinition/au-patient

key:
  v: inv-pat-1
severity:
  v: warning
human:
  v: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
expression:
  v: extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-patient
  link: http://hl7.org.au/fhir/StructureDefinition/au-patient

key:
  v: inv-pat-2
severity:
  v: warning
human:
  v: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
expression:
  v: extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-patient
  link: http://hl7.org.au/fhir/StructureDefinition/au-patient

key:
  v: inv-pat-3
severity:
  v: warning
human:
  v: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply
expression:
  v: extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-patient
  link: http://hl7.org.au/fhir/StructureDefinition/au-patient

key:
  v: inv-pat-4
severity:
  v: warning
human:
  v: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
expression:
  v: extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-patient
  link: http://hl7.org.au/fhir/StructureDefinition/au-patient

key:
  v: inv-pat-5
severity:
  v: warning
human:
  v: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply
expression:
  v: extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-patient
  link: http://hl7.org.au/fhir/StructureDefinition/au-patient

key:
  v: inv-pat-6
severity:
  v: warning
human:
  v: Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply
expression:
  v: extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-patient
  link: http://hl7.org.au/fhir/StructureDefinition/au-patient

key:
  v: au-core-pat-01
severity:
  v: error
human:
  v: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
expression:
  v: (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
xpath:
  v: (exists(f:identifier/f:system) and exists(f:identifier/f:value)) and not(exists(f:identifier/f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])) or not(exists(f:identifier/f:system) and exists(f:identifier/f:value)) and exists(f:identifier/f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])
source:
  v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
  link: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient

key:
  v: au-core-pat-02
severity:
  v: error
human:
  v: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
expression:
  v: name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
xpath:
  v: (exists(f:name/f:family) and not(exists(f:name/f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason']))) or (not(exists(f:name/f:family)) and exists(f:name/f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason']))
source:
  v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
  link: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient

key:
  v: inv-01-family-name-length-not-absent
severity:
  v: warning
human:
  v: Family name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331
expression:
  v: Patient.name.family.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.family.matches('^.{1,40}$')
source:
  v: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-patient
  link: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-patient

key:
  v: inv-02-given-name-length-if-not-absent
severity:
  v: warning
human:
  v: Given name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331
expression:
  v: Patient.name.given.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.given.matches('^.{1,40}$')
source:
  v: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-patient
  link: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-patient

v: false

v: false

identity:
  v: rim
map:
  v: Entity. Role, or Act

identity:
  v: rim
map:
  v: Patient[classCode=PAT]

identity:
  v: cda
map:
  v: ClinicalDocument.recordTarget.patientRole

id:
  v: Patient.id
path:
  v: Patient.id
short:
  v: Logical id of this artifact
definition:
  v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
comment:
  v: The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: id
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: true

id:
  v: Patient.meta
path:
  v: Patient.meta
short:
  v: Metadata about the resource
definition:
  v: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: Patient.implicitRules
path:
  v: Patient.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
comment:
  v: Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
is summary:
  v: true

id:
  v: Patient.language
path:
  v: Patient.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
    value: canonical
      v: http://hl7.org/fhir/ValueSet/all-languages
      link: http://hl7.org/fhir/ValueSet/all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: Language
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages|4.0.1
    link: 4.0
    link: .1

id:
  v: Patient.text
path:
  v: Patient.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
comment:
  v: Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: Patient.contained
path:
  v: Patient.contained
short:
  v: Contained, inline Resources
definition:
  v: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
comment:
  v: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension
path:
  v: Patient.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 2
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:birthPlace
path:
  v: Patient.extension
slice name:
  v: birthPlace
short:
  v: Place of Birth for patient
definition:
  v: The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/patient-birthPlace|5.3.0
    link: 5.3
    link: .0
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:indigenousStatus
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.extension
slice name:
  v: indigenousStatus
short:
  v: Indigenous status
definition:
  v: National Health Data Dictionary (NHDD) based indigenous status for a person.
comment:
  v: This concept is equivalent to Australian Institute of Health and Welfare data element 602543 [Person—Indigenous status, code N](https://meteor.aihw.gov.au/content/index.phtml/itemId/602543).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
    link: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:veteranStatus
path:
  v: Patient.extension
slice name:
  v: veteranStatus
short:
  v: Veteran / Australian Defence Force (ADF) status
definition:
  v: Veteran / Australian Defence Force (ADF) status for a person.
comment:
  v: This concept is equivalent to Australian Institute of Health and Welfare data element 737931 [Person—ADF veteran status, code N](https://meteor.aihw.gov.au/content/737931).
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/veteran-status
    link: http://hl7.org.au/fhir/StructureDefinition/veteran-status
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:closingTheGapRegistration
path:
  v: Patient.extension
slice name:
  v: closingTheGapRegistration
short:
  v: Closing the Gap co-payment eligibility indicator
definition:
  v: Indication of eligibility for the Closing the Gap co-payment.
comment:
  v: This concept is equivalent to Australian Institute of Health and Welfare data element 603671 [Patient—Closing the Gap co-payment eligibility indicator](https://meteor.aihw.gov.au/content/index.phtml/itemId/603671).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
    link: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:mothersMaidenName
path:
  v: Patient.extension
slice name:
  v: mothersMaidenName
short:
  v: Mother's Maiden name
definition:
  v: Mother's maiden (unmarried) name, commonly collected to help verify patient identity.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName|5.3.0
    link: 5.3
    link: .0
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: PID-6
mapping:
  identity:
    v: rim
  map:
    v: Role relationship to entity with maiden name (?)

id:
  v: Patient.extension:interpreterRequired
path:
  v: Patient.extension
slice name:
  v: interpreterRequired
short:
  v: Whether an interpreter is required
definition:
  v: Indicates whether an interpreter is required to facilitate communication in a healthcare setting. While this extension is named patient-interpreterRequired for backwards compatibility, it may also be used on RelatedPerson, Practitioner, and Encounter.
comment:
  v: The individual does not speak the default language of the organization, and hence requires an interpreter. If other languages are in the Communications list, then that would be the type of interpreter required. *While this extension is named patient-interpreterRequired for backwards compatibility, it may also be used on RelatedPerson, Practitioner, and Encounter.* When used on Patient, RelatedPerson, or Practitioner, it indicates a default or assumed need for an interpreter. When used on Encounter, it indicates that an interpreter is needed to facilitate communication between some participants in that Encounter. The encounter-level evaluation of whether an interpreter is needed might involve evaluating the language proficiencies of the participants.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired|5.3.0
    link: 5.3
    link: .0
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:dateOfArrival
path:
  v: Patient.extension
slice name:
  v: dateOfArrival
short:
  v: The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
definition:
  v: The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more. This date is captured once for a person and is not subsequently updated with subsequent arrivals.
comment:
  v: See [Australian Bureau of Statics (ABS) 1200.0.55.007 - Year of Arrival Standard, 2014, Version 1.5](https://www.abs.gov.au/statistics/standards/year-arrival-standard/2014-version-15) for further information. This concept is equivalent to Australian Institute of Health and Welfare data element 269447 [Person—year of first arrival in Australia](https://meteor.aihw.gov.au/content/index.phtml/itemId/269447).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
    link: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:genderIdentity
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.extension
slice name:
  v: genderIdentity
short:
  v: The individual's gender identity
definition:
  v: An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.
comment:
  v: This represents an individual’s identity, ascertained by asking them what that identity is.
min:
  v: 1
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0
    link: 5.3
    link: .0
condition:
  v: inv-pat-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:individualPronouns
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.extension
slice name:
  v: individualPronouns
short:
  v: Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
definition:
  v: The pronouns to use when referring to an individual in verbal or written communication.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0
    link: 5.3
    link: .0
condition:
  v: inv-pat-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:recordedSexOrGender
path:
  v: Patient.extension
slice name:
  v: recordedSexOrGender
short:
  v: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
definition:
  v: A sex or gender property for the individual from a document or other record
comment:
  v: The type of recorded sex or gender is populated in the `extension:type.value[x]` of the [Person Recorded Sex or Gender](http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) extension and shall contain one of the codes from the [AU Recorded Sex or Gender Type](https://hl7.org.au/fhir/6.0.0/ValueSet-rsg-type.html) value set if any of the codes within the value set can apply. The document from which the sex or gender property was acquired is populated in the `extension:sourceDocument.value[x]` of the [Person Recorded Sex or Gender](http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) extension and shall contain one of the codes from the [AU Recorded Sex or Gender (RSG) Source Document Type](https://hl7.org.au/fhir/6.0.0/ValueSet-rsg-source-document-type.html) value set if any of the codes within the value set can apply. The jurisdiction that issued the document where the sex or gender was acquired is populated in the `extension:jurisdiction.value[x]` of the [Person Recorded Sex or Gender](http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) extension and shall contain one of the codes from the [Jurisdiction ValueSet - AU Extended](https://hl7.org.au/fhir/6.0.0/ValueSet-au-jurisdiction-extended.html) value set if any of the codes within the value set can apply. The non-document source from which the sex or gender property was acquired is populated in the `extension:source.value[x]` of the [Person Recorded Sex or Gender](http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) extension and shall contain one of the codes from the [AU Recorded Sex or Gender (RSG) Source](https://hl7.org.au/fhir/6.0.0/ValueSet-rsg-source.html) value set if any of the codes within the value set can apply.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender|5.3.0
    link: 5.3
    link: .0
condition:
  v: inv-pat-3
condition:
  v: inv-pat-4
condition:
  v: inv-pat-5
condition:
  v: inv-pat-6
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:sexParameterForClinicalUse
path:
  v: Patient.extension
slice name:
  v: sexParameterForClinicalUse
short:
  v: A context-specific sex parameter for clinical use
definition:
  v: A parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc..
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse|5.3.0
    link: 5.3
    link: .0
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.extension:informalCarer
path:
  v: Patient.extension
slice name:
  v: informalCarer
short:
  v: Patient's informal carer information
definition:
  v: This extension can be used to represent information about an informal carer of a patient. An informal carer includes any person, such as a family member, friend or neighbour, who is giving regular, ongoing assistance to another person. This may provide healthcare providers with additional information on the patients support system and identified contact person. The definition for the patient’s informal carer existence indicator is the same described in the [definition section](https://meteor.aihw.gov.au/content/787901) of the NMDS. Additionally, this extension allows for the representation of the carer information.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer
    link: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.modifierExtension
path:
  v: Patient.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.identifier
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.identifier
slicing:
  discriminator:
    type:
      v: pattern
    path:
      v: type
  rules:
    v: open
short:
  v: Identifies this patient across multiple systems
definition:
  v: An identifier for this patient.
requirements:
  v: Patients are almost always assigned specific numerical identifiers.
min:
  v: 1
max:
  v: *
base:
  path:
    v: Patient.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
  profile:
    v: http://hl7.org/fhir/StructureDefinition/Identifier
    link: http://hl7.org/fhir/StructureDefinition/Identifier
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-ihi
    link: http://hl7.org.au/fhir/StructureDefinition/au-ihi
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber
    link: http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-dvanumber
    link: http://hl7.org.au/fhir/StructureDefinition/au-dvanumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber
    link: http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber
    link: http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-cwlthseniorshealthcardnumber
    link: http://hl7.org.au/fhir/StructureDefinition/au-cwlthseniorshealthcardnumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber
    link: http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-insurancemembernumber
    link: http://hl7.org.au/fhir/StructureDefinition/au-insurancemembernumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-pi
    link: http://hl7.org.au/fhir/StructureDefinition/au-pi
condition:
  v: au-core-pat-01
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: id
mapping:
  identity:
    v: cda
  map:
    v: .id

id:
  v: Patient.identifier:ihi
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.identifier
slice name:
  v: ihi
short:
  v: Identifies this patient across multiple systems
definition:
  v: An identifier for this patient.
requirements:
  v: Patients are almost always assigned specific numerical identifiers.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-ihi
    link: http://hl7.org.au/fhir/StructureDefinition/au-ihi
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: id
mapping:
  identity:
    v: cda
  map:
    v: .id

id:
  v: Patient.identifier:medicare
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.identifier
slice name:
  v: medicare
short:
  v: Identifies this patient across multiple systems
definition:
  v: An identifier for this patient.
requirements:
  v: Patients are almost always assigned specific numerical identifiers.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber
    link: http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: id
mapping:
  identity:
    v: cda
  map:
    v: .id

id:
  v: Patient.identifier:dva
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.identifier
slice name:
  v: dva
short:
  v: Identifies this patient across multiple systems
definition:
  v: An identifier for this patient.
requirements:
  v: Patients are almost always assigned specific numerical identifiers.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-dvanumber
    link: http://hl7.org.au/fhir/StructureDefinition/au-dvanumber
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: id
mapping:
  identity:
    v: cda
  map:
    v: .id

id:
  v: Patient.active
path:
  v: Patient.active
short:
  v: Whether this patient's record is in active use
definition:
  v: Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
comment:
  v: If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.
requirements:
  v: Need to be able to mark a patient record as not to be used because it was created in error.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.active
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
meaning when missing:
  v: This resource is generally assumed to be active if no value is provided for the active element
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status
mapping:
  identity:
    v: rim
  map:
    v: statusCode
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.name
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.name
slicing:
  discriminator:
    type:
      v: value
    path:
      v: use
  rules:
    v: open
short:
  v: A name associated with the patient
definition:
  v: A name associated with the individual.
comment:
  v: A patient may have multiple names with different uses or applicable periods. At least one name SHOULD be the name the patient is considered to have for administrative and record keeping purposes - family name is used to enable matching against patient records.
requirements:
  v: Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
min:
  v: 1
max:
  v: *
base:
  path:
    v: Patient.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: HumanName
condition:
  v: au-core-pat-02
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: au-core-pat-03
  severity:
    v: error
  human:
    v: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
  expression:
    v: (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
  xpath:
    v: (exists(f:text) or exists(f:family) or exists(f:given)) and not (exists(f:text) and exists(f:family) and exists(f:given)) or exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])
  source:
    v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
    link: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-5, PID-9
mapping:
  identity:
    v: rim
  map:
    v: name
mapping:
  identity:
    v: cda
  map:
    v: .patient.name

id:
  v: Patient.name.id
path:
  v: Patient.name.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.extension
path:
  v: Patient.name.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.use
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.name.use
short:
  v: usual | official | temp | nickname | anonymous | old | maiden
definition:
  v: Identifies the purpose for this name.
comment:
  v: Applications can assume that a name is current unless it explicitly says that it is temporary or old.
requirements:
  v: Allows the appropriate name for a particular context of use to be selected from among a set of names.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: NameUse
  strength:
    v: required
  description:
    v: The use of a human name.
  value set:
    v: http://hl7.org/fhir/ValueSet/name-use|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: XPN.7, but often indicated by which field contains the name
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./NamePurpose

id:
  v: Patient.name.text
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.name.text
short:
  v: Text representation of the full name
definition:
  v: Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
comment:
  v: Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
requirements:
  v: A renderable, unencoded form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: implied by XPN.11
mapping:
  identity:
    v: rim
  map:
    v: ./formatted

id:
  v: Patient.name.family
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.name.family
short:
  v: Patient's family name
definition:
  v: The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
comment:
  v: Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
alias:
  v: surname
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HumanName.family
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.1/FN.1
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = FAM]
mapping:
  identity:
    v: servd
  map:
    v: ./FamilyName

id:
  v: Patient.name.given
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.name.given
short:
  v: Patient's given name
definition:
  v: Given name.
comment:
  v: If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
alias:
  v: first name
alias:
  v: middle name
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.given
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: Given Names appear in the correct order for presenting the name
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.2 + XPN.3
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = GIV]
mapping:
  identity:
    v: servd
  map:
    v: ./GivenNames

id:
  v: Patient.name.prefix
path:
  v: Patient.name.prefix
short:
  v: Parts that come before the name
definition:
  v: Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.prefix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: Prefixes appear in the correct order for presenting the name
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.5
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = PFX]
mapping:
  identity:
    v: servd
  map:
    v: ./TitleCode

id:
  v: Patient.name.suffix
path:
  v: Patient.name.suffix
short:
  v: Parts that come after the name
definition:
  v: Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.suffix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: Suffixes appear in the correct order for presenting the name
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN/4
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = SFX]

id:
  v: Patient.name.period
path:
  v: Patient.name.period
short:
  v: Time period when name was/is in use
definition:
  v: Indicates the period of time when this name was valid for the named person.
requirements:
  v: Allows names to be placed in historical context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.13 + XPN.14
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: Patient.name:preferredName
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.name
slice name:
  v: preferredName
short:
  v: A name associated with the patient
definition:
  v: A name associated with the individual.
comment:
  v: A patient may have multiple names with different uses or applicable periods. At least one name SHOULD be the name the patient is considered to have for administrative and record keeping purposes - family name is used to enable matching against patient records.
requirements:
  v: Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: HumanName
condition:
  v: au-core-pat-02
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: au-core-pat-03
  severity:
    v: error
  human:
    v: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
  expression:
    v: (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
  xpath:
    v: (exists(f:text) or exists(f:family) or exists(f:given)) and not (exists(f:text) and exists(f:family) and exists(f:given)) or exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])
  source:
    v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
    link: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-5, PID-9
mapping:
  identity:
    v: rim
  map:
    v: name
mapping:
  identity:
    v: cda
  map:
    v: .patient.name

id:
  v: Patient.name:preferredName.id
path:
  v: Patient.name.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name:preferredName.extension
path:
  v: Patient.name.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name:preferredName.use
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.name.use
short:
  v: usual | official | temp | nickname | anonymous | old | maiden
definition:
  v: Identifies the purpose for this name.
comment:
  v: Applications can assume that a name is current unless it explicitly says that it is temporary or old.
requirements:
  v: Allows the appropriate name for a particular context of use to be selected from among a set of names.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HumanName.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
fixed: code
  v: usual
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: NameUse
  strength:
    v: required
  description:
    v: The use of a human name.
  value set:
    v: http://hl7.org/fhir/ValueSet/name-use|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: XPN.7, but often indicated by which field contains the name
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./NamePurpose

id:
  v: Patient.name:preferredName.text
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.name.text
short:
  v: Text representation of the full name
definition:
  v: Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
comment:
  v: Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
requirements:
  v: A renderable, unencoded form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: implied by XPN.11
mapping:
  identity:
    v: rim
  map:
    v: ./formatted

id:
  v: Patient.name:preferredName.family
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.name.family
short:
  v: Patient's family name
definition:
  v: The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
comment:
  v: Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
alias:
  v: surname
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HumanName.family
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.1/FN.1
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = FAM]
mapping:
  identity:
    v: servd
  map:
    v: ./FamilyName

id:
  v: Patient.name:preferredName.given
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.name.given
short:
  v: Patient's given name
definition:
  v: Given name.
comment:
  v: If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
alias:
  v: first name
alias:
  v: middle name
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.given
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: Given Names appear in the correct order for presenting the name
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.2 + XPN.3
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = GIV]
mapping:
  identity:
    v: servd
  map:
    v: ./GivenNames

id:
  v: Patient.name:preferredName.prefix
path:
  v: Patient.name.prefix
short:
  v: Parts that come before the name
definition:
  v: Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.prefix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: Prefixes appear in the correct order for presenting the name
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.5
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = PFX]
mapping:
  identity:
    v: servd
  map:
    v: ./TitleCode

id:
  v: Patient.name:preferredName.suffix
path:
  v: Patient.name.suffix
short:
  v: Parts that come after the name
definition:
  v: Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.suffix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: Suffixes appear in the correct order for presenting the name
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN/4
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = SFX]

id:
  v: Patient.name:preferredName.period
path:
  v: Patient.name.period
short:
  v: Time period when name was/is in use
definition:
  v: Indicates the period of time when this name was valid for the named person.
requirements:
  v: Allows names to be placed in historical context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.13 + XPN.14
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: Patient.telecom
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.telecom
short:
  v: A contact detail for the individual
definition:
  v: A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
comment:
  v: A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
requirements:
  v: People have (primary) ways to contact them in some way such as phone, email.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-13, PID-14, PID-40
mapping:
  identity:
    v: rim
  map:
    v: telecom
mapping:
  identity:
    v: cda
  map:
    v: .telecom

id:
  v: Patient.telecom.id
path:
  v: Patient.telecom.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.telecom.extension
path:
  v: Patient.telecom.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.telecom.system
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.telecom.system
short:
  v: phone | fax | email | pager | url | sms | other
definition:
  v: Telecommunications form for contact point - what communications system is required to make use of the contact.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
condition:
  v: cpt-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: ContactPointSystem
  strength:
    v: required
  description:
    v: Telecommunications form for contact point.
  value set:
    v: http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: XTN.3
mapping:
  identity:
    v: rim
  map:
    v: ./scheme
mapping:
  identity:
    v: servd
  map:
    v: ./ContactPointType

id:
  v: Patient.telecom.value
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.telecom.value
short:
  v: The actual contact point details
definition:
  v: The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
comment:
  v: Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
requirements:
  v: Need to support legacy numbers that are not in a tightly controlled format.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XTN.1 (or XTN.12)
mapping:
  identity:
    v: rim
  map:
    v: ./url
mapping:
  identity:
    v: servd
  map:
    v: ./Value

id:
  v: Patient.telecom.use
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.telecom.use
short:
  v: home | work | temp | old | mobile - purpose of this contact point
definition:
  v: Identifies the purpose for the contact point.
comment:
  v: Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
requirements:
  v: Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: ContactPointUse
  strength:
    v: required
  description:
    v: Use of contact point.
  value set:
    v: http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: XTN.2 - but often indicated by field
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./ContactPointPurpose

id:
  v: Patient.telecom.rank
path:
  v: Patient.telecom.rank
short:
  v: Specify preferred order of use (1 = highest)
definition:
  v: Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
comment:
  v: Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.rank
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: positiveInt
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.telecom.period
path:
  v: Patient.telecom.period
short:
  v: Time period when the contact point was/is in use
definition:
  v: Time period when the contact point was/is in use.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: Patient.gender
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.gender
short:
  v: male | female | other | unknown
definition:
  v: Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
comment:
  v: The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.
requirements:
  v: Needed for identification of the individual, in combination with (at least) name and birth date.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.gender
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: AdministrativeGender
  strength:
    v: required
  description:
    v: The gender of a person used for administrative purposes.
  value set:
    v: http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: PID-8
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
mapping:
  identity:
    v: cda
  map:
    v: .patient.administrativeGenderCode

id:
  v: Patient.birthDate
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.birthDate
short:
  v: Patient's date of birth
definition:
  v: The date of birth for the individual.
comment:
  v: At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).
requirements:
  v: Age of the individual drives many clinical processes. May include accuracy indicator and specific birth time.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.birthDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
condition:
  v: inv-pat-0
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-7
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
mapping:
  identity:
    v: cda
  map:
    v: .patient.birthTime
mapping:
  identity:
    v: loinc
  map:
    v: 21112-8

id:
  v: Patient.birthDate.id
path:
  v: Patient.birthDate.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.birthDate.extension
path:
  v: Patient.birthDate.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.birthDate.extension:accuracyIndicator
path:
  v: Patient.birthDate.extension
slice name:
  v: accuracyIndicator
short:
  v: Patient's date of birth accuracy indicator
definition:
  v: General date accuracy indicator coding.
comment:
  v: In some circumstances, systems may capture date or dateTime data that has unknown or estimated parts. This coding indicates the accuracy of the day, month and year parts. This concept is equivalent to Australian Institute of Health and Welfare data element 294418 [Date—accuracy indicator](https://meteor.aihw.gov.au/content/index.phtml/itemId/294418).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
    link: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.birthDate.extension:birthTime
path:
  v: Patient.birthDate.extension
slice name:
  v: birthTime
short:
  v: Birth time
definition:
  v: The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
comment:
  v: The patient prefix on the extension was retained to ensure backward compatibility with existing data (the content itself is provided to assist in sharing data across patient resources effectively)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/patient-birthTime|5.3.0
    link: 5.3
    link: .0
condition:
  v: inv-pat-0
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.birthDate.value
path:
  v: Patient.birthDate.value
representation:
  v: xmlAttr
short:
  v: Primitive value for date
definition:
  v: The actual value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: date.value
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: date
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/regex
    value: string
      v: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?
  code:
    v: http://hl7.org/fhirpath/System.Date
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.deceased[x]
path:
  v: Patient.deceased[x]
slicing:
  discriminator:
    type:
      v: type
    path:
      v: $this
  ordered:
    v: false
  rules:
    v: closed
short:
  v: Indicates if the individual is deceased or not
definition:
  v: Indicates if the individual is deceased or not. Deceased date accuracy indicator is optional.
comment:
  v: If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
requirements:
  v: The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.deceased[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
type:
  code:
    v: dateTime
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-30 (bool) and PID-29 (datetime)
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.deceased[x]:deceasedBoolean
path:
  v: Patient.deceased[x]
slice name:
  v: deceasedBoolean
short:
  v: Deceased indicator
definition:
  v: Boolean indicator if the individual is deceased or not.
comment:
  v: If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
requirements:
  v: The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.deceased[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-30 (bool) and PID-29 (datetime)
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.deceased[x]:deceasedDateTime
path:
  v: Patient.deceased[x]
slice name:
  v: deceasedDateTime
short:
  v: Deceased date time
definition:
  v: Individual deceased date-time with optional accuracy indicator.
comment:
  v: If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
requirements:
  v: The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.deceased[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-30 (bool) and PID-29 (datetime)
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.deceased[x]:deceasedDateTime.id
path:
  v: Patient.deceased[x].id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.deceased[x]:deceasedDateTime.extension
path:
  v: Patient.deceased[x].extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.deceased[x]:deceasedDateTime.extension:accuracyIndicator
path:
  v: Patient.deceased[x].extension
slice name:
  v: accuracyIndicator
short:
  v: Deceased date accuracy indicator
definition:
  v: General date accuracy indicator coding.
comment:
  v: In some circumstances, systems may only have date or datetime data that has unknown or estimated parts. This coding establishes the accuracy of the day, month and year parts.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
    link: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.deceased[x]:deceasedDateTime.value
path:
  v: Patient.deceased[x].value
representation:
  v: xmlAttr
short:
  v: Primitive value for dateTime
definition:
  v: The actual value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: dateTime.value
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: dateTime
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/regex
    value: string
      v: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?
  code:
    v: http://hl7.org/fhirpath/System.DateTime
is modifier:
  v: false
is summary:
  v: false

id:
  v: Patient.address
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.address
short:
  v: An address for the individual
definition:
  v: An address for the individual.
comment:
  v: The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
requirements:
  v: May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.address
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Address
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-address
    link: http://hl7.org.au/fhir/StructureDefinition/au-address
  profile:
    v: http://hl7.org/fhir/StructureDefinition/Address
    link: http://hl7.org/fhir/StructureDefinition/Address
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-11
mapping:
  identity:
    v: rim
  map:
    v: addr
mapping:
  identity:
    v: cda
  map:
    v: .addr

id:
  v: Patient.maritalStatus
path:
  v: Patient.maritalStatus
short:
  v: Marital (civil) status of a patient
definition:
  v: This field contains a patient's most recent marital (civil) status.
requirements:
  v: Most, if not all systems capture it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.maritalStatus
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: MaritalStatus
  strength:
    v: extensible
  description:
    v: The domestic partnership status of a person.
  value set:
    v: http://hl7.org/fhir/ValueSet/marital-status|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: PID-16
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN]/maritalStatusCode
mapping:
  identity:
    v: cda
  map:
    v: .patient.maritalStatusCode

id:
  v: Patient.multipleBirth[x]
path:
  v: Patient.multipleBirth[x]
short:
  v: Whether patient is part of a multiple birth
definition:
  v: Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
comment:
  v: Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).
requirements:
  v: For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.multipleBirth[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
type:
  code:
    v: integer
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: PID-24 (bool), PID-25 (integer)
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.photo
path:
  v: Patient.photo
short:
  v: Image of the patient
definition:
  v: Image of the patient.
comment:
  v: Guidelines: * Use id photos, not clinical photos. * Limit dimensions to thumbnail. * Keep byte count low to ease resource updates.
requirements:
  v: Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.photo
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Attachment
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 - needs a profile
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact
path:
  v: Patient.contact
short:
  v: A contact party (e.g. guardian, partner, friend) for the patient
definition:
  v: A contact party (e.g. guardian, partner, friend) for the patient.
comment:
  v: Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.
requirements:
  v: Need to track people you can contact about the patient.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.contact
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: pat-1
  severity:
    v: error
  human:
    v: SHALL at least contain a contact's details or a reference to an organization
  expression:
    v: name.exists() or telecom.exists() or address.exists() or organization.exists()
  xpath:
    v: exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)
  source:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact.id
path:
  v: Patient.contact.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.extension
path:
  v: Patient.contact.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.modifierExtension
path:
  v: Patient.contact.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.contact.relationship
path:
  v: Patient.contact.relationship
short:
  v: The kind of relationship
definition:
  v: The nature of the relationship between the patient and the contact person.
requirements:
  v: Used to determine which contact person is the most relevant to approach, depending on circumstances.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.contact.relationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  strength:
    v: extensible
  value set:
    v: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
    link: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
mapping:
  identity:
    v: v2
  map:
    v: NK1-7, NK1-3
mapping:
  identity:
    v: rim
  map:
    v: code
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact.name
path:
  v: Patient.contact.name
short:
  v: A name associated with the contact person
definition:
  v: A name associated with the contact person.
requirements:
  v: Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.contact.name
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: HumanName
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: NK1-2
mapping:
  identity:
    v: rim
  map:
    v: name
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact.telecom
path:
  v: Patient.contact.telecom
short:
  v: A contact detail for the person
definition:
  v: A contact detail for the person, e.g. a telephone number or an email address.
comment:
  v: Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.
requirements:
  v: People have (primary) ways to contact them in some way such as phone, email.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.contact.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: NK1-5, NK1-6, NK1-40
mapping:
  identity:
    v: rim
  map:
    v: telecom
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact.address
path:
  v: Patient.contact.address
short:
  v: Address for the contact person
definition:
  v: Address for the contact person.
comment:
  v: The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
requirements:
  v: Need to keep track where the contact person can be contacted per postal mail or visited.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.contact.address
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Address
  profile:
    v: http://hl7.org/fhir/StructureDefinition/Address
    link: http://hl7.org/fhir/StructureDefinition/Address
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-address
    link: http://hl7.org.au/fhir/StructureDefinition/au-address
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: NK1-4
mapping:
  identity:
    v: rim
  map:
    v: addr
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact.gender
path:
  v: Patient.contact.gender
short:
  v: male | female | other | unknown
definition:
  v: Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
requirements:
  v: Needed to address the person correctly.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.contact.gender
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: AdministrativeGender
  strength:
    v: required
  description:
    v: The gender of a person used for administrative purposes.
  value set:
    v: http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: NK1-15
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact.organization
path:
  v: Patient.contact.organization
short:
  v: Organization that is associated with the contact
definition:
  v: Organization on behalf of which the contact is acting or for which the contact is working.
requirements:
  v: For guardians or business related contacts, the organization is relevant.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.contact.organization
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization|4.0.1
    link: 4.0
    link: .1
condition:
  v: pat-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
mapping:
  identity:
    v: rim
  map:
    v: scoper
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact.period
path:
  v: Patient.contact.period
short:
  v: The period during which this contact person or organization is valid to be contacted relating to this patient
definition:
  v: The period during which this contact person or organization is valid to be contacted relating to this patient.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.contact.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: effectiveTime
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.communication
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.communication
short:
  v: A language which may be used to communicate with the patient about his or her health
definition:
  v: A language which may be used to communicate with the patient about his or her health.
comment:
  v: If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
requirements:
  v: If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.communication
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: LanguageCommunication
mapping:
  identity:
    v: cda
  map:
    v: patient.languageCommunication

id:
  v: Patient.communication.id
path:
  v: Patient.communication.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.communication.extension
path:
  v: Patient.communication.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.communication.modifierExtension
path:
  v: Patient.communication.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.language
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.communication.language
short:
  v: The language which can be used to communicate with the patient about his or her health
definition:
  v: The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.
comment:
  v: The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
requirements:
  v: Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.communication.language
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
binding:
  strength:
    v: extensible
  value set:
    v: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
    link: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
mapping:
  identity:
    v: v2
  map:
    v: PID-15, LAN-2
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
mapping:
  identity:
    v: cda
  map:
    v: .languageCode

id:
  v: Patient.communication.preferred
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
extension:
  extension:
    url:
      v: code
    value: code
      v: SHALL:no-error
  extension:
    url:
      v: actor
    value: canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      link: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
    value: canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient|2.0.0
      link: 2.0
      link: .0
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
path:
  v: Patient.communication.preferred
short:
  v: Language preference indicator
definition:
  v: Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
comment:
  v: This language is specifically identified for communicating healthcare information.
requirements:
  v: People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.communication.preferred
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: PID-15
mapping:
  identity:
    v: rim
  map:
    v: preferenceInd
mapping:
  identity:
    v: cda
  map:
    v: .preferenceInd

id:
  v: Patient.generalPractitioner
path:
  v: Patient.generalPractitioner
short:
  v: Patient's nominated primary care provider
definition:
  v: Patient's nominated care provider.
comment:
  v: This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.
alias:
  v: careProvider
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.generalPractitioner
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization|4.0.1
    link: 4.0
    link: .1
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner|4.0.1
    link: 4.0
    link: .1
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1
    link: 4.0
    link: .1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: PD1-4
mapping:
  identity:
    v: rim
  map:
    v: subjectOf.CareEvent.performer.AssignedEntity
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.managingOrganization
path:
  v: Patient.managingOrganization
short:
  v: Organization that is the custodian of the patient record
definition:
  v: Organization that is the custodian of the patient record.
comment:
  v: There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).
requirements:
  v: Need to know who recognizes this patient record, manages and updates it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.managingOrganization
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization|4.0.1
    link: 4.0
    link: .1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: scoper
mapping:
  identity:
    v: cda
  map:
    v: .providerOrganization

id:
  v: Patient.link
path:
  v: Patient.link
short:
  v: Link to a Patient or RelatedPerson resource that concerns the same actual person
definition:
  v: Link to a Patient or RelatedPerson resource that concerns the same actual person.
comment:
  v: There is no assumption that linked patient records have mutual links.
requirements:
  v: There are multiple use cases: * Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.link
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: outboundLink
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.link.id
path:
  v: Patient.link.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.link.extension
path:
  v: Patient.link.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.link.modifierExtension
path:
  v: Patient.link.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.link.other
path:
  v: Patient.link.other
short:
  v: The other patient or related person resource that the link refers to
definition:
  v: The other patient resource that the link refers to.
comment:
  v: Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.link.other
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy
    value: boolean
      v: false
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient|4.0.1
    link: 4.0
    link: .1
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson|4.0.1
    link: 4.0
    link: .1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-3, MRG-1
mapping:
  identity:
    v: rim
  map:
    v: id
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.link.type
path:
  v: Patient.link.type
short:
  v: replaced-by | replaces | refer | seealso
definition:
  v: The type of link between this patient resource and another patient resource.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.link.type
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: LinkType
  strength:
    v: required
  description:
    v: The type of link between this patient resource and another patient resource.
  value set:
    v: http://hl7.org/fhir/ValueSet/link-type|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: rim
  map:
    v: typeCode
mapping:
  identity:
    v: cda
  map:
    v: n/a

element:
  id:
    v: Patient
  path:
    v: Patient
  short:
    v: Clinical Note Document Patient
  constraint:
    key:
      v: inv-01-family-name-length-not-absent
    severity:
      v: warning
    human:
      v: Family name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331
    expression:
      v: Patient.name.family.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.family.matches('^.{1,40}$')
    source:
      v: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-patient
      link: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-patient
  constraint:
    key:
      v: inv-02-given-name-length-if-not-absent
    severity:
      v: warning
    human:
      v: Given name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331
    expression:
      v: Patient.name.given.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.given.matches('^.{1,40}$')
    source:
      v: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-patient
      link: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-patient
element:
  id:
    v: Patient.extension
  path:
    v: Patient.extension
  min:
    v: 2
element:
  id:
    v: Patient.extension:indigenousStatus
  path:
    v: Patient.extension
  slice name:
    v: indigenousStatus
  min:
    v: 1
element:
  id:
    v: Patient.extension:genderIdentity
  path:
    v: Patient.extension
  slice name:
    v: genderIdentity
  min:
    v: 1
element:
  id:
    v: Patient.extension:sexParameterForClinicalUse
  path:
    v: Patient.extension
  slice name:
    v: sexParameterForClinicalUse
  must support:
    v: true
element:
  id:
    v: Patient.extension:informalCarer
  path:
    v: Patient.extension
  slice name:
    v: informalCarer
  short:
    v: Patient's informal carer information
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Extension
    profile:
      v: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer
      link: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer
element:
  id:
    v: Patient.name
  path:
    v: Patient.name
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: use
    rules:
      v: open
element:
  id:
    v: Patient.name.family
  path:
    v: Patient.name.family
  short:
    v: Patient's family name
  min:
    v: 1
element:
  id:
    v: Patient.name.given
  path:
    v: Patient.name.given
  short:
    v: Patient's given name
element:
  id:
    v: Patient.name:preferredName
  path:
    v: Patient.name
  slice name:
    v: preferredName
  min:
    v: 0
  max:
    v: 1
element:
  id:
    v: Patient.name:preferredName.use
  path:
    v: Patient.name.use
  min:
    v: 1
  fixed: code
    v: usual
element:
  id:
    v: Patient.name:preferredName.family
  path:
    v: Patient.name.family
  min:
    v: 1
element:
  id:
    v: Patient.birthDate
  path:
    v: Patient.birthDate
  short:
    v: Patient's date of birth
element:
  id:
    v: Patient.birthDate.extension:accuracyIndicator
  path:
    v: Patient.birthDate.extension
  slice name:
    v: accuracyIndicator
  short:
    v: Patient's date of birth accuracy indicator