dh-relatedperson-core-1
type: StructureDefinition
node role: treeRoot
id:
  v: dh-relatedperson-core-1
text:
  status:
    v: extensions
  div: Generated Narrative: StructureDefinition dh-relatedperson-core-1 Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> RelatedPerson C 0..* AUBaseRelatedPerson A person related to a patient in an Australian healthcare context inv-dh-relper-01: If present, name shall at least have text, family name, or given name Slices for identifier S 0..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber A human identifier for this person Slice: Unordered, Open by pattern:type identifier:ihi S 0..1 AUIHI Individual Healthcare Identifier (IHI) identifier:medicare S 0..1 AUMedicareCardNumber Medicare Card Number identifier:dva S 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number active 0..1 boolean Whether this related person's record is in active use Fixed Value: true patient SC 1..1 Reference(ADHA Core Patient) The patient this person is related to inv-dh-relper-02: At least a reference, identifier or display shall be present relationship S 1..* CodeableConcept The nature of the relationship name SC 0..* HumanName A name associated with the person telecom S 0..* ContactPoint A contact detail for the person address S 0..* Address, AustralianAddress Address where the related person can be contacted or visited communication S 0..* BackboneElement A language which may be used to communicate with about the patient's health language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health preferred S 0..1 boolean Language preference indicator <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
url:
  v: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1
version:
  v: 1.2.0
name:
  v: ADHARelatedPersonCore
title:
  v: ADHA Core RelatedPerson
status:
  v: active
experimental:
  v: false
date:
  v: 2024-09-19T11:15:09+10:00
publisher:
  v: Australian Digital Health Agency
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: email
description:
  v: The purpose of this profile is to provide a core representation of a related person for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: AU
copyright:
  v: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
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
kind:
  v: resource
abstract:
  v: false
type:
  v: RelatedPerson
base definition:
  v: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
  link: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: RelatedPerson
    path:
      v: RelatedPerson
    short:
      v: A person related to a patient in an Australian healthcare context
    definition:
      v: A person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. A related person might be a family member, close friend, carer, legal guardian, or someone with enduring power of attorney.
    comment:
      v: In the context of the My Health Record, a related person may manage another individual's My Health Record as an authorised representative, or they may view or help manage another individual's My Health Record as a nominated representative.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: RelatedPerson
      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:
      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)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: inv-relper-0
      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').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
      source:
        v: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
        link: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
    constraint:
      key:
        v: inv-relper-1
      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').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
      source:
        v: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
        link: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
    constraint:
      key:
        v: inv-relper-2
      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').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
      source:
        v: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
        link: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson

v: true

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-relper-3
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').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
  link: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson

key:
  v: inv-relper-4
severity:
  v: warning
human:
  v: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended 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').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
  link: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson

key:
  v: inv-dh-relper-01
severity:
  v: error
human:
  v: If present, name shall at least have text, family name, or given name
expression:
  v: name.exists() implies name.all(text.exists() or family.exists() or given.exists())
source:
  v: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1
  link: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1

v: false

v: false

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

identity:
  v: rim
map:
  v: role

id:
  v: RelatedPerson.id
path:
  v: RelatedPerson.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:
      v: id
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: true

id:
  v: RelatedPerson.meta
path:
  v: RelatedPerson.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: RelatedPerson.implicitRules
path:
  v: RelatedPerson.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: RelatedPerson.language
path:
  v: RelatedPerson.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:
      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:
      v: Language
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages
    link: http://hl7.org/fhir/ValueSet/languages

id:
  v: RelatedPerson.text
path:
  v: RelatedPerson.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: RelatedPerson.contained
path:
  v: RelatedPerson.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: RelatedPerson.extension
path:
  v: RelatedPerson.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: 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: RelatedPerson.extension:genderIdentity
path:
  v: RelatedPerson.extension
slice name:
  v: genderIdentity
short:
  v: Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
definition:
  v: An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.
comment:
  v: Individual Gender identity [Gender Identity Response](https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1) ([Extensible](http://hl7.org/fhir/R4/terminologies.html#extensible)).
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-genderIdentity
    link: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
condition:
  v: inv-relper-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

id:
  v: RelatedPerson.extension:individualPronouns
path:
  v: RelatedPerson.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.
comment:
  v: Individual Pronouns [Australian Pronouns](https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1) ([Extensible](http://hl7.org/fhir/R4/terminologies.html#extensible)).
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
    link: http://hl7.org/fhir/StructureDefinition/individual-pronouns
condition:
  v: inv-relper-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
is modifier:
  v: false

id:
  v: RelatedPerson.extension:recordedSexOrGender
path:
  v: RelatedPerson.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 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: Person Recorded Sex Or Gender type [AU Recorded Sex or Gender Type](http://hl7.org.au/fhir/4.2.2-ballot/ValueSet-rsg-type.html) ([extensible](http://hl7.org/fhir/R4/terminologies.html#extensible)). Person Recorded Sex Or Gender source document [AU Recorded Sex or Gender (RSG) Source Document Type](http://hl7.org.au/fhir/4.2.2-ballot/ValueSet-rsg-source-document-type.html) ([extensible](http://hl7.org/fhir/R4/terminologies.html#extensible)). Person Recorded Sex Or Gender jurisdiction [Jurisdiction ValueSet - AU Extended](http://hl7.org.au/fhir/4.2.2-ballot/ValueSet-au-jurisdiction-extended.html) ([extensible](http://hl7.org/fhir/R4/terminologies.html#extensible)).
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
    link: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
condition:
  v: inv-relper-2
condition:
  v: inv-relper-3
condition:
  v: inv-relper-4
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

id:
  v: RelatedPerson.modifierExtension
path:
  v: RelatedPerson.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: RelatedPerson.identifier
path:
  v: RelatedPerson.identifier
slicing:
  discriminator:
    type:
      v: pattern
    path:
      v: type
  rules:
    v: open
short:
  v: A human identifier for this person
definition:
  v: Identifier for a person within a particular scope.
requirements:
  v: People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.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
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
must support:
  v: true
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CX / EI (occasionally, more often EI maps to a resource id or a URL)
mapping:
  identity:
    v: rim
  map:
    v: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
mapping:
  identity:
    v: servd
  map:
    v: Identifier

id:
  v: RelatedPerson.identifier:ihi
path:
  v: RelatedPerson.identifier
slice name:
  v: ihi
short:
  v: Individual Healthcare Identifier (IHI)
definition:
  v: Individual Healthcare Identifier (IHI) assigned under the HI Service to a patient.
requirements:
  v: People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.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
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: inv-ihi-value-0
  severity:
    v: error
  human:
    v: IHI shall be an exactly 16 digit number
  expression:
    v: value.matches('^([0-9]{16})$')
  source:
    v: http://hl7.org.au/fhir/StructureDefinition/au-ihi
    link: http://hl7.org.au/fhir/StructureDefinition/au-ihi
constraint:
  key:
    v: inv-ihi-value-1
  severity:
    v: error
  human:
    v: IHI prefix is 800360
  expression:
    v: value.startsWith('800360')
  source:
    v: http://hl7.org.au/fhir/StructureDefinition/au-ihi
    link: http://hl7.org.au/fhir/StructureDefinition/au-ihi
constraint:
  key:
    v: inv-ihi-value-2
  severity:
    v: error
  human:
    v: IHI shall pass the Luhn algorithm check
  expression:
    v: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
  source:
    v: http://hl7.org.au/fhir/StructureDefinition/au-ihi
    link: http://hl7.org.au/fhir/StructureDefinition/au-ihi
must support:
  v: true
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CX / EI (occasionally, more often EI maps to a resource id or a URL)
mapping:
  identity:
    v: rim
  map:
    v: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
mapping:
  identity:
    v: servd
  map:
    v: Identifier

id:
  v: RelatedPerson.identifier:medicare
path:
  v: RelatedPerson.identifier
slice name:
  v: medicare
short:
  v: Medicare Card Number
definition:
  v: Medicare card number as either the the 10 digit Medicare card number or the 11 digit number (includes the individual reference number (IRN)). A Medicare card is provided to individuals who are enrolled in Medicare.
requirements:
  v: People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.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
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
must support:
  v: true
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CX / EI (occasionally, more often EI maps to a resource id or a URL)
mapping:
  identity:
    v: rim
  map:
    v: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
mapping:
  identity:
    v: servd
  map:
    v: Identifier

id:
  v: RelatedPerson.identifier:dva
path:
  v: RelatedPerson.identifier
slice name:
  v: dva
short:
  v: Department of Veterans' Affairs (DVA) Number
definition:
  v: Department of Veterans’ Affairs (DVA) file number displayed on a Veteran Card.
requirements:
  v: People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.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
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
must support:
  v: true
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CX / EI (occasionally, more often EI maps to a resource id or a URL)
mapping:
  identity:
    v: rim
  map:
    v: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
mapping:
  identity:
    v: servd
  map:
    v: Identifier

id:
  v: RelatedPerson.active
path:
  v: RelatedPerson.active
short:
  v: Whether this related person's record is in active use
definition:
  v: Whether this related person record is in active use.
comment:
  v: This element is labeled as a modifier because it may be used to mark that the resource was created in error.
requirements:
  v: Need to be able to mark a related person record as not to be used, such as if it was created in error.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.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
fixed:
  v: true
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

id:
  v: RelatedPerson.patient
path:
  v: RelatedPerson.patient
short:
  v: The patient this person is related to
definition:
  v: The patient this person is related to.
requirements:
  v: We need to know which patient this RelatedPerson is related to.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: RelatedPerson.patient
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1
    link: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1
condition:
  v: inv-dh-relper-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: inv-dh-relper-02
  severity:
    v: error
  human:
    v: At least a reference, identifier or display shall be present
  expression:
    v: reference.exists() or identifier.exists() or display.exists()
  xpath:
    v: exists(f:reference) or exists(f:identifier) or exists(f:display)
  source:
    v: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1
    link: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id

id:
  v: RelatedPerson.relationship
path:
  v: RelatedPerson.relationship
short:
  v: The nature of the relationship
definition:
  v: The nature of the relationship between a patient and the related person.
requirements:
  v: We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.
min:
  v: 1
max:
  v: *
base:
  path:
    v: RelatedPerson.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
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: PatientRelationshipType
  strength:
    v: extensible
  value set:
    v: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
    link: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class
mapping:
  identity:
    v: v2
  map:
    v: NK1-3
mapping:
  identity:
    v: rim
  map:
    v: code

id:
  v: RelatedPerson.name
path:
  v: RelatedPerson.name
short:
  v: A name associated with the person
definition:
  v: A name associated with the person.
requirements:
  v: Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: HumanName
condition:
  v: inv-dh-relper-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: v2
  map:
    v: NK1-2
mapping:
  identity:
    v: rim
  map:
    v: name

id:
  v: RelatedPerson.telecom
path:
  v: RelatedPerson.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: Person 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: RelatedPerson.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: NK1-5 / NK1-6 / NK1-40
mapping:
  identity:
    v: rim
  map:
    v: telecom

id:
  v: RelatedPerson.gender
path:
  v: RelatedPerson.gender
short:
  v: male | female | other | unknown
definition:
  v: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
requirements:
  v: Needed for identification of the person, in combination with (at least) name and birth date.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.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: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      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: administrativeGender

id:
  v: RelatedPerson.birthDate
path:
  v: RelatedPerson.birthDate
short:
  v: The date on which the related person was born
definition:
  v: The date on which the related person was born.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.birthDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
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: player.birthTime

id:
  v: RelatedPerson.address
path:
  v: RelatedPerson.address
short:
  v: Address where the related person can be contacted or visited
definition:
  v: Address where the related person can be contacted or visited.
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 related person can be contacted per postal mail or visited.
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.address
  min:
    v: 0
  max:
    v: *
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
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
must support:
  v: true
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD
mapping:
  identity:
    v: rim
  map:
    v: AD
mapping:
  identity:
    v: servd
  map:
    v: Address

id:
  v: RelatedPerson.photo
path:
  v: RelatedPerson.photo
short:
  v: Image of the person
definition:
  v: Image of the person.
requirements:
  v: Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.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' and determinerCode='INSTANCE']/desc

id:
  v: RelatedPerson.period
path:
  v: RelatedPerson.period
short:
  v: Period of time that this relationship is considered valid
definition:
  v: The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.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: w5
  map:
    v: FiveWs.done[x]
mapping:
  identity:
    v: rim
  map:
    v: .effectiveTime

id:
  v: RelatedPerson.communication
path:
  v: RelatedPerson.communication
short:
  v: A language which may be used to communicate with about the patient's health
definition:
  v: A language which may be used to communicate with about the patient's 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 RelatedPerson.Communication associations. If the RelatedPerson 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 related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.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

id:
  v: RelatedPerson.communication.id
path:
  v: RelatedPerson.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:
      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: RelatedPerson.communication.extension
path:
  v: RelatedPerson.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: RelatedPerson.communication.modifierExtension
path:
  v: RelatedPerson.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: RelatedPerson.communication.language
path:
  v: RelatedPerson.communication.language
short:
  v: The language which can be used to communicate with the patient about his or her health
definition:
  v: A language which can be used to communicate with about the patient's health. 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: RelatedPerson.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: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code

id:
  v: RelatedPerson.communication.preferred
path:
  v: RelatedPerson.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: RelatedPerson.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: rim
  map:
    v: preferenceInd

element:
  id:
    v: RelatedPerson
  path:
    v: RelatedPerson
  definition:
    v: A person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. A related person might be a family member, close friend, carer, legal guardian, or someone with enduring power of attorney.
  comment:
    v: In the context of the My Health Record, a related person may manage another individual's My Health Record as an authorised representative, or they may view or help manage another individual's My Health Record as a nominated representative.
  constraint:
    key:
      v: inv-dh-relper-01
    severity:
      v: error
    human:
      v: If present, name shall at least have text, family name, or given name
    expression:
      v: name.exists() implies name.all(text.exists() or family.exists() or given.exists())
    source:
      v: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1
      link: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1
element:
  id:
    v: RelatedPerson.identifier
  path:
    v: RelatedPerson.identifier
  slicing:
    discriminator:
      type:
        v: pattern
      path:
        v: type
    rules:
      v: open
  definition:
    v: Identifier for a person within a particular scope.
  must support:
    v: true
element:
  id:
    v: RelatedPerson.identifier:ihi
  path:
    v: RelatedPerson.identifier
  slice name:
    v: ihi
  max:
    v: 1
  type:
    code:
      v: Identifier
    profile:
      v: http://hl7.org.au/fhir/StructureDefinition/au-ihi
      link: http://hl7.org.au/fhir/StructureDefinition/au-ihi
  must support:
    v: true
element:
  id:
    v: RelatedPerson.identifier:medicare
  path:
    v: RelatedPerson.identifier
  slice name:
    v: medicare
  max:
    v: 1
  type:
    code:
      v: Identifier
    profile:
      v: http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber
      link: http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber
  must support:
    v: true
element:
  id:
    v: RelatedPerson.identifier:dva
  path:
    v: RelatedPerson.identifier
  slice name:
    v: dva
  max:
    v: 1
  type:
    code:
      v: Identifier
    profile:
      v: http://hl7.org.au/fhir/StructureDefinition/au-dvanumber
      link: http://hl7.org.au/fhir/StructureDefinition/au-dvanumber
  must support:
    v: true
element:
  id:
    v: RelatedPerson.active
  path:
    v: RelatedPerson.active
  fixed:
    v: true
element:
  id:
    v: RelatedPerson.patient
  path:
    v: RelatedPerson.patient
  type:
    code:
      v: Reference
    target profile:
      v: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1
      link: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1
  condition:
    v: inv-dh-relper-02
  constraint:
    key:
      v: inv-dh-relper-02
    severity:
      v: error
    human:
      v: At least a reference, identifier or display shall be present
    expression:
      v: reference.exists() or identifier.exists() or display.exists()
    xpath:
      v: exists(f:reference) or exists(f:identifier) or exists(f:display)
    source:
      v: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1
      link: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1
  must support:
    v: true
element:
  id:
    v: RelatedPerson.relationship
  path:
    v: RelatedPerson.relationship
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: RelatedPerson.name
  path:
    v: RelatedPerson.name
  condition:
    v: inv-dh-relper-01
  must support:
    v: true
element:
  id:
    v: RelatedPerson.telecom
  path:
    v: RelatedPerson.telecom
  must support:
    v: true
element:
  id:
    v: RelatedPerson.address
  path:
    v: RelatedPerson.address
  definition:
    v: Address where the related person can be contacted or visited.
  must support:
    v: true
element:
  id:
    v: RelatedPerson.communication
  path:
    v: RelatedPerson.communication
  must support:
    v: true
element:
  id:
    v: RelatedPerson.communication.language
  path:
    v: RelatedPerson.communication.language
  must support:
    v: true
element:
  id:
    v: RelatedPerson.communication.preferred
  path:
    v: RelatedPerson.communication.preferred
  must support:
    v: true