au-ps-relatedperson
type: StructureDefinition
node role: treeRoot
id:
  v: au-ps-relatedperson
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition au-ps-relatedperson Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> RelatedPerson 0..* AUCoreRelatedPerson A person related to a patient in an Australian healthcare context #xD; patient O 1..1 Reference(AU PS Patient) The patient this person is related to Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer #xD; reference SO 1..1 string Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer #xD; relationship O 0..* CodeableConceptIPS The nature of the relationship Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer #xD; name O 0..* HumanName A name associated with the person Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer #xD; use O 0..1 code usual | official | temp | nickname | anonymous | old | maiden Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer #xD; text O 0..1 string Text representation of the full name Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer #xD; family O 0..1 string Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer #xD; given O 0..* string Given names (not always 'first'). Includes middle names Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer #xD; telecom O 0..* ContactPoint A contact detail for the person Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer #xD; address O 0..* Address, AustralianAddress Address where the related person can be contacted or visited Obligations…
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
    l: structuredefinition-fmm
  value: Integer
    v: 1
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: draft
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
        l: structuredefinition-conformance-derivedFrom
      value: Canonical
        v: http://hl7.org.au/fhir/ps/ImplementationGuide/hl7.fhir.au.ps
        l: hl7.fhir.au.ps
url:
  v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  l: au-ps-relatedperson
version:
  v: 0.6.0-cibuild
name:
  v: AUPSRelatedPerson
title:
  v: AU PS RelatedPerson
status:
  v: active
date:
  v: 2026-02-15T11:53:43+00:00
publisher:
  v: HL7 Australia
contact:
  name:
    v: HL7 Australia FHIR Work Group
  telecom:
    system:
      v: url
    value:
      v: https://confluence.hl7.org/display/HAFWG
    use:
      v: work
description:
  v: This profile sets minimum expectations for a RelatedPerson resource in the context of a patient summary in an Australian context. It is based on the [AU Core Related Person](https://build.fhir.org/ig/hl7au/au-fhir-core/StructureDefinition-au-core-relatedperson.html) profile, and applies the additional constraints for use in a patient summary context consistent with the profiling conventions of [IPS](https://hl7.org/fhir/uv/ips/STU2/).
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: AU
copyright:
  v: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
    l: fivews
  name:
    v: FiveWs Pattern Mapping
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
    l: v2
  name:
    v: HL7 v2 Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: RelatedPerson
  l: RelatedPerson
base definition:
  v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  l: au-core-relatedperson
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 2.0.1-ci-build
  element:
    id:
      v: RelatedPerson
    path:
      v: RelatedPerson
    short:
      v: A person related to a patient in an Australian healthcare context
    definition:
      v: Information about 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.
    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
        l: 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
        l: 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
        l: 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
        l: 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)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource

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-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').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-relatedperson
  l: au-relatedperson

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').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
  l: au-relatedperson

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

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').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-relatedperson
  l: 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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
source:
  v: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
  l: au-relatedperson

key:
  v: inv-relper-5
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-relatedperson
  l: au-relatedperson

key:
  v: au-core-relper-01
severity:
  v: error
human:
  v: Either a name or a relationship shall be provided (or both)
expression:
  v: name.exists() or relationship.exists()
source:
  v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  l: au-core-relatedperson

key:
  v: au-core-relper-02
severity:
  v: error
human:
  v: Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present
expression:
  v: name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())
source:
  v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  l: au-core-relatedperson

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
      l: structuredefinition-fhir-type
    value: Url
      v: id
      l: id
  code:
    v: http://hl7.org/fhirpath/System.String
    l: 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
    l: 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
    l: 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
    l: 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
    l: 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
    l: 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
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
      l: elementdefinition-maxValueSet
    value: Canonical
      v: http://hl7.org/fhir/ValueSet/all-languages
      l: all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: 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
    l: 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
    l: 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
    l: 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
    l: 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
    l: 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
    l: 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
    l: 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: The individual's gender identity is populated in the `extension:value.value[x]` of the [Individual Gender Identity](http://hl7.org/fhir/StructureDefinition/individual-genderIdentity) extension and shall contain one of the codes from the [Gender Identity Response](https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1) value set if any of the codes within the value set can apply. See [Australian Bureau of Statics (ABS) Standard for Sex, Gender, Variations of Sex Characteristics and Sexual Orientation Variables, 2020](https://www.abs.gov.au/statistics/standards/standard-sex-gender-variations-sex-characteristics-and-sexual-orientation-variables/latest-release#gender) for further materials.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
    l: 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
    l: 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
    l: Extension
is modifier:
  v: false
is summary:
  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: The individual's pronouns are populated in the `extension:value.value[x]` of the [Individual Pronouns](http://hl7.org/fhir/StructureDefinition/individual-pronouns) extension and shall contain one of the codes from the [Australian Pronouns](https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1) 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
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/individual-pronouns
    l: 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
    l: 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
    l: Extension
is modifier:
  v: false
is summary:
  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. 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://build.fhir.org/ig/hl7au/au-fhir-base/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://build.fhir.org/ig/hl7au/au-fhir-base/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://build.fhir.org/ig/hl7au/au-fhir-base/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://build.fhir.org/ig/hl7au/au-fhir-base/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
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    l: individual-recordedSexOrGender
condition:
  v: inv-relper-2
condition:
  v: inv-relper-3
condition:
  v: inv-relper-4
condition:
  v: inv-relper-5
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
    l: 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
    l: Extension
is modifier:
  v: false
is summary:
  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
    l: 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
    l: 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
    l: 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
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
    l: Identifier
  profile:
    v: http://hl7.org/fhir/StructureDefinition/Identifier
    l: Identifier
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-ihi
    l: au-ihi
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber
    l: au-medicarecardnumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-dvanumber
    l: au-dvanumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber
    l: au-healthcarecardnumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber
    l: au-pensionerconcessioncardnumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-cwlthseniorshealthcardnumber
    l: au-cwlthseniorshealthcardnumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber
    l: au-medicalrecordnumber
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-insurancemembernumber
    l: au-insurancemembernumber
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
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: v2
  map:
    v: NK1-33
mapping:
  identity:
    v: rim
  map:
    v: .id

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
    l: 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
    l: 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
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      l: au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:no-error
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      l: au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:display
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
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
    l: Reference
  target profile:
    v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient
    l: au-ps-patient
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
    l: Element
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.patient.id
path:
  v: RelatedPerson.patient.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
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.patient.extension
path:
  v: RelatedPerson.patient.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
    l: 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
    l: 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
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.patient.reference
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:display
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.patient.reference
short:
  v: Literal reference, Relative, internal or absolute URL
definition:
  v: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
comment:
  v: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Reference.reference
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
condition:
  v: ref-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
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.patient.type
path:
  v: RelatedPerson.patient.type
short:
  v: Type the reference refers to (e.g. "Patient")
definition:
  v: The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
comment:
  v: This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: 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
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: FHIRResourceTypeExt
  strength:
    v: extensible
  description:
    v: Aa resource (or, for logical models, the URI of the logical model).
  value set:
    v: http://hl7.org/fhir/ValueSet/resource-types|4.0.1
    l: http://hl7.org/fhir/ValueSet/resource-types
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.patient.identifier
path:
  v: RelatedPerson.patient.identifier
short:
  v: Logical reference, when literal reference is not known
definition:
  v: An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
comment:
  v: When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.identifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier
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
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .identifier

id:
  v: RelatedPerson.patient.display
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: RelatedPerson.patient.display
short:
  v: Text alternative for the resource
definition:
  v: Plain text narrative that identifies the resource in addition to the resource reference.
comment:
  v: This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: 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
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.relationship
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      l: au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:no-error
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      l: au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:display
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
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: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.relationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
  profile:
    v: http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips
    l: CodeableConcept-uv-ips
condition:
  v: au-core-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
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: PatientRelationshipType
  strength:
    v: extensible
  value set:
    v: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
    l: 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
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      l: au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:no-error
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      l: au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:display
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
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
    l: HumanName
condition:
  v: au-core-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
    l: 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.name.id
path:
  v: RelatedPerson.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
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.name.extension
path:
  v: RelatedPerson.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
    l: 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
    l: 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
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.name.use
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      l: au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:no-error
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      l: au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.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
    l: 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
    l: 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
      l: 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
    l: http://hl7.org/fhir/ValueSet/name-use
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: RelatedPerson.name.text
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      l: au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:no-error
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      l: au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:display
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.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
    l: 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
    l: 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: RelatedPerson.name.family
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      l: au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:no-error
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      l: au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.name.family
short:
  v: Family name (often called 'Surname')
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: 0
max:
  v: 1
base:
  path:
    v: HumanName.family
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: 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
    l: 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: RelatedPerson.name.given
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      l: au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:no-error
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      l: au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.name.given
short:
  v: Given names (not always 'first'). Includes middle names
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
    l: 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
    l: 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: RelatedPerson.name.prefix
path:
  v: RelatedPerson.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
    l: 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
    l: 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: RelatedPerson.name.suffix
path:
  v: RelatedPerson.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
    l: 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
    l: 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: RelatedPerson.name.period
path:
  v: RelatedPerson.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
    l: 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
    l: 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: RelatedPerson.telecom
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      l: au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:no-error
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      l: au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:display
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
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
    l: 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
    l: 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
    l: 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
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: 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
    l: http://hl7.org/fhir/ValueSet/administrative-gender
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
    l: 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
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: player.birthTime

id:
  v: RelatedPerson.address
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
      l: au-core-actor-responder
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:no-error
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
      l: au-core-actor-requester
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson|2.0.1-ci-build
      l: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:display
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson|0.6.0-cibuild
      l: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
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
    l: Address
  profile:
    v: http://hl7.org/fhir/StructureDefinition/Address
    l: Address
  profile:
    v: http://hl7.org.au/fhir/StructureDefinition/au-address
    l: 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
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: NK1-4
mapping:
  identity:
    v: rim
  map:
    v: addr

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
    l: 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
    l: 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
    l: 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
    l: 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
    l: 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
    l: Element
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
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: 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
    l: 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
    l: 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
    l: 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
    l: 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
    l: 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
    l: 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
    l: 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
    l: Element
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
    l: 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
    l: 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
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: preferenceInd

element:
  id:
    v: RelatedPerson
  path:
    v: RelatedPerson
element:
  id:
    v: RelatedPerson.patient
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHALL:populate-if-known
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
        l: au-ps-actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHALL:handle
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
        l: au-ps-actor-consumer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHOULD:display
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
        l: au-ps-actor-consumer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: RelatedPerson.patient
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient
      l: au-ps-patient
element:
  id:
    v: RelatedPerson.patient.reference
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHALL:populate-if-known
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
        l: au-ps-actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHALL:handle
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
        l: au-ps-actor-consumer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHOULD:display
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
        l: au-ps-actor-consumer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: RelatedPerson.patient.reference
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: RelatedPerson.relationship
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHALL:populate-if-known
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
        l: au-ps-actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHALL:handle
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
        l: au-ps-actor-consumer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHOULD:display
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
        l: au-ps-actor-consumer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: RelatedPerson.relationship
  type:
    code:
      v: CodeableConcept
      l: CodeableConcept
    profile:
      v: http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips
      l: CodeableConcept-uv-ips
element:
  id:
    v: RelatedPerson.name
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHALL:populate-if-known
    extension:
      url:
        v: actor
        l: actor
      value: Canonical

extension:
  url:
    v: code
    l: code
  value: Code
    v: SHALL:handle
extension:
  url:
    v: actor
    l: actor
  value: Canonical
    v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
    l: au-ps-actor-consumer
url:
  v: http://hl7.org/fhir/StructureDefinition/obligation
  l: obligation

extension:
  url:
    v: code
    l: code
  value: Code
    v: SHOULD:display
extension:
  url:
    v: actor
    l: actor
  value: Canonical
    v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
    l: au-ps-actor-consumer
url:
  v: http://hl7.org/fhir/StructureDefinition/obligation
  l: obligation

v: RelatedPerson.name

id:
  v: RelatedPerson.name.use
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.name.use

id:
  v: RelatedPerson.name.text
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:display
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.name.text

id:
  v: RelatedPerson.name.family
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.name.family

id:
  v: RelatedPerson.name.given
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.name.given

id:
  v: RelatedPerson.telecom
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:display
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.telecom

id:
  v: RelatedPerson.address
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:populate-if-known
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-producer
      l: au-ps-actor-producer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:handle
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:display
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: http://hl7.org.au/fhir/ps/ActorDefinition/au-ps-actor-consumer
      l: au-ps-actor-consumer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: RelatedPerson.address