MODS-RelatedPerson
type: StructureDefinition
node role: treeRoot
id:
  v: MODS-RelatedPerson
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition MODS-RelatedPerson Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> RelatedPerson 0..* UKCoreRelatedPerson A person that is related to a patient, but who is not a direct target of care #xD; Slices for extension Content/Rules for all slices #xD; extension:organisation 0..1 Reference(MODS Organization) Extension MODS Person Care Provider URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider #xD; Slices for telecom 0..* ContactPoint A contact detail for the person Slice: Unordered, Open by value:system #xD; telecom:email 0..* ContactPoint A contact detail for the person #xD; extension 1..* Extension Extension #xD; Slices for extension Content/Rules for all slices #xD; extension:emailAddressType S 1..1 Coding Extension MODS Person Email Address Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType Binding: MODS Email Address Type (required) #xD; system 1..1 code phone | fax | email | pager | url | sms | other Required Pattern: email #xD; value 1..1 string The actual contact point details #xD; telecom:phone 0..* ContactPoint A contact detail for the person #xD; extension 1..* Extension Extension #xD; Slices for extension Content/Rules for all slices #xD; extension:telephoneNumberType S 1..1 Coding Extension MODS Person Telephone Number Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType Binding: MODS Person Telephone Number Type Code (required) #xD; system 1..1 code phone | fax | email | pager | url | sms | other Required Pattern: phone #xD; value 1..1 string The actual contact point details #xD; address #xD; extension 1..* Extension Extension #xD; Slices for extension Content/Rules for all slices #xD; extension:addressCountry S 1..1 Coding Extension MODS Address Country…
url:
  v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-RelatedPerson
  l: MODS-RelatedPerson
version:
  v: 0.1.0
name:
  v: MODSRelatedPerson
title:
  v: MODS Related Person
status:
  v: draft
date:
  v: 2026-03-24T16:18:08+00:00
publisher:
  v: Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform
contact:
  name:
    v: Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform
  telecom:
    system:
      v: url
    value:
      v: https://synanetics.com
  telecom:
    system:
      v: email
description:
  v: This profile defines the MODS constraints and extensions on the UKCore FHIR Resource [RelatedPerson](https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson)
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: GB
    display:
      v: United Kingdom of Great Britain and Northern Ireland
fhir version:
  v: 4.0.1
kind:
  v: resource
abstract:
  v: false
type:
  v: RelatedPerson
  l: RelatedPerson
base definition:
  v: https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson
  l: UKCore-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.5.0
  element:
    id:
      v: RelatedPerson
    path:
      v: RelatedPerson
    short:
      v: A person that is related to a patient, but who is not a direct target of care
    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-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-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:
      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
    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
    mapping:
      identity:
        v: rim
      map:
        v: Entity. Role, or Act
    mapping:
      identity:
        v: rim
      map:
        v: role
  element:
    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:
        value: Url
      code:
        v: http://hl7.org/fhirpath/System.String
        l: System.String
    is summary:
      v: true

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.

Url
v: id
l: id

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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a

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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
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
    l: languages
mapping:
  identity:
    v: rim
  map:
    v: n/a

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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A
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
mapping:
  identity:
    v: rim
  map:
    v: Entity. Role, or Act
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.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 resource. 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: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.extension:contactPreference
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.extension
slice name:
  v: contactPreference
short:
  v: The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
definition:
  v: The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
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: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
    l: Extension-UKCore-ContactPreference
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.extension:copyCorrespondenceIndicator
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.extension
slice name:
  v: copyCorrespondenceIndicator
short:
  v: Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence
definition:
  v: Extension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence.
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: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
    l: Extension-UKCore-CopyCorrespondenceIndicator
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.extension:organisation
path:
  v: RelatedPerson.extension
slice name:
  v: organisation
short:
  v: Extension MODS Person Care Provider
definition:
  v: A provider organisation, registered with the Care Quality Commission to provide personal care and support to the Subject of care.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
    l: Extension-MODS-PersonCareProvider
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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

id:
  v: RelatedPerson.modifierExtension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.modifierExtension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CX / EI (occasionally, more often EI maps to a resource id or a URL)
mapping:
  identity:
    v: rim
  map:
    v: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
mapping:
  identity:
    v: servd
  map:
    v: Identifier
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
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: rim
  map:
    v: n/a
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status
mapping:
  identity:
    v: rim
  map:
    v: .statusCode

id:
  v: RelatedPerson.patient
path:
  v: RelatedPerson.patient
short:
  v: The patient this person is related to
definition:
  v: The patient this person is related to.
comment:
  v: References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
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/fhir/StructureDefinition/Patient
    l: Patient
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ref-1
  severity:
    v: error
  human:
    v: SHALL have a contained resource if a local reference is provided
  expression:
    v: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
  xpath:
    v: not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Reference
    l: Reference
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id

id:
  v: RelatedPerson.relationship
path:
  v: RelatedPerson.relationship
short:
  v: The nature of the relationship
definition:
  v: The nature of the relationship between a patient and the related person.
comment:
  v: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
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
  description:
    v: The nature of the relationship between a patient and the related person.
  value set:
    v: https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
    l: UKCore-PersonRelationshipType
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CE/CNE/CWE
mapping:
  identity:
    v: rim
  map:
    v: CD
mapping:
  identity:
    v: orim
  map:
    v: fhir:CodeableConcept rdfs:subClassOf dt:CD
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class
mapping:
  identity:
    v: v2
  map:
    v: NK1-3
mapping:
  identity:
    v: rim
  map:
    v: code

id:
  v: RelatedPerson.name
path:
  v: RelatedPerson.name
short:
  v: A name associated with the person
definition:
  v: A name associated with the person.
comment:
  v: Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
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: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XPN
mapping:
  identity:
    v: rim
  map:
    v: EN (actually, PN)
mapping:
  identity:
    v: servd
  map:
    v: ProviderName
mapping:
  identity:
    v: v2
  map:
    v: NK1-2
mapping:
  identity:
    v: rim
  map:
    v: name

id:
  v: RelatedPerson.telecom
path:
  v: RelatedPerson.telecom
slicing:
  discriminator:
    type:
      v: value
    path:
      v: system
  rules:
    v: open
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: cpt-2
  severity:
    v: error
  human:
    v: A system is required if a value is provided.
  expression:
    v: value.empty() or system.exists()
  xpath:
    v: not(exists(f:value)) or exists(f:system)
  source:
    v: http://hl7.org/fhir/StructureDefinition/ContactPoint
    l: ContactPoint
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XTN
mapping:
  identity:
    v: rim
  map:
    v: TEL
mapping:
  identity:
    v: servd
  map:
    v: ContactPoint
mapping:
  identity:
    v: v2
  map:
    v: NK1-5 / NK1-6 / NK1-40
mapping:
  identity:
    v: rim
  map:
    v: telecom

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

id:
  v: RelatedPerson.telecom.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.telecom.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.telecom.system
path:
  v: RelatedPerson.telecom.system
short:
  v: phone | fax | email | pager | url | sms | other
definition:
  v: Telecommunications form for contact point - what communications system is required to make use of the contact.
comment:
  v: Note that FHIR strings SHALL NOT exceed 1MB in size
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
condition:
  v: ele-1
condition:
  v: cpt-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ContactPointSystem
  strength:
    v: required
  description:
    v: Telecommunications form for contact point.
  value set:
    v: http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
    l: http://hl7.org/fhir/ValueSet/contact-point-system
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XTN.3
mapping:
  identity:
    v: rim
  map:
    v: ./scheme
mapping:
  identity:
    v: servd
  map:
    v: ./ContactPointType

id:
  v: RelatedPerson.telecom.system.id
path:
  v: RelatedPerson.telecom.system.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
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.telecom.system.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.telecom.system.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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.telecom.system.extension:otherContactSystem
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.telecom.system.extension
slice name:
  v: otherContactSystem
short:
  v: Other contact system
definition:
  v: Other contact system value which extends the system element in the ContactPoint datatype.
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: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
    l: Extension-UKCore-OtherContactSystem
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.telecom.system.value
path:
  v: RelatedPerson.telecom.system.value
representation:
  v: xmlAttr
short:
  v: Primitive value for code
definition:
  v: Primitive value for code
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  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: code
      l: code
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/regex
      l: regex
    value: String
      v: [^\s]+(\s[^\s]+)*
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
max length:
  v: 1048576

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

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

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

id:
  v: RelatedPerson.telecom.period
path:
  v: RelatedPerson.telecom.period
short:
  v: Time period when the contact point was/is in use
definition:
  v: Time period when the contact point was/is in use.
comment:
  v: A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: per-1
  severity:
    v: error
  human:
    v: If present, start SHALL have a lower value than end
  expression:
    v: start.hasValue().not() or end.hasValue().not() or (start <= end)
  xpath:
    v: not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))
  source:
    v: http://hl7.org/fhir/StructureDefinition/Period
    l: Period
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: DR
mapping:
  identity:
    v: rim
  map:
    v: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: RelatedPerson.telecom:email
path:
  v: RelatedPerson.telecom
slice name:
  v: email
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: cpt-2
  severity:
    v: error
  human:
    v: A system is required if a value is provided.
  expression:
    v: value.empty() or system.exists()
  xpath:
    v: not(exists(f:value)) or exists(f:system)
  source:
    v: http://hl7.org/fhir/StructureDefinition/ContactPoint
    l: ContactPoint
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XTN
mapping:
  identity:
    v: rim
  map:
    v: TEL
mapping:
  identity:
    v: servd
  map:
    v: ContactPoint
mapping:
  identity:
    v: v2
  map:
    v: NK1-5 / NK1-6 / NK1-40
mapping:
  identity:
    v: rim
  map:
    v: telecom

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

id:
  v: RelatedPerson.telecom:email.extension
path:
  v: RelatedPerson.telecom.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 1
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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

id:
  v: RelatedPerson.telecom:email.extension:emailAddressType
path:
  v: RelatedPerson.telecom.extension
slice name:
  v: emailAddressType
short:
  v: Extension MODS Person Email Address Type
definition:
  v: MODS type of email address, home, work
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType
    l: Extension-MODS-PersonEmailAddressType
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
must support:
  v: true

id:
  v: RelatedPerson.telecom:email.system
path:
  v: RelatedPerson.telecom.system
short:
  v: phone | fax | email | pager | url | sms | other
definition:
  v: Telecommunications form for contact point - what communications system is required to make use of the contact.
comment:
  v: Note that FHIR strings SHALL NOT exceed 1MB in size
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ContactPoint.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
pattern: Code
  v: email
condition:
  v: ele-1
condition:
  v: cpt-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ContactPointSystem
  strength:
    v: required
  description:
    v: Telecommunications form for contact point.
  value set:
    v: http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
    l: http://hl7.org/fhir/ValueSet/contact-point-system
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XTN.3
mapping:
  identity:
    v: rim
  map:
    v: ./scheme
mapping:
  identity:
    v: servd
  map:
    v: ./ContactPointType

id:
  v: RelatedPerson.telecom:email.system.id
path:
  v: RelatedPerson.telecom.system.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
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.telecom:email.system.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.telecom.system.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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.telecom:email.system.extension:otherContactSystem
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.telecom.system.extension
slice name:
  v: otherContactSystem
short:
  v: Other contact system
definition:
  v: Other contact system value which extends the system element in the ContactPoint datatype.
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: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
    l: Extension-UKCore-OtherContactSystem
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.telecom:email.system.value
path:
  v: RelatedPerson.telecom.system.value
representation:
  v: xmlAttr
short:
  v: Primitive value for code
definition:
  v: Primitive value for code
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  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: code
      l: code
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/regex
      l: regex
    value: String
      v: [^\s]+(\s[^\s]+)*
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
max length:
  v: 1048576

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

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

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

id:
  v: RelatedPerson.telecom:email.period
path:
  v: RelatedPerson.telecom.period
short:
  v: Time period when the contact point was/is in use
definition:
  v: Time period when the contact point was/is in use.
comment:
  v: A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: per-1
  severity:
    v: error
  human:
    v: If present, start SHALL have a lower value than end
  expression:
    v: start.hasValue().not() or end.hasValue().not() or (start <= end)
  xpath:
    v: not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))
  source:
    v: http://hl7.org/fhir/StructureDefinition/Period
    l: Period
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: DR
mapping:
  identity:
    v: rim
  map:
    v: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: RelatedPerson.telecom:phone
path:
  v: RelatedPerson.telecom
slice name:
  v: phone
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: cpt-2
  severity:
    v: error
  human:
    v: A system is required if a value is provided.
  expression:
    v: value.empty() or system.exists()
  xpath:
    v: not(exists(f:value)) or exists(f:system)
  source:
    v: http://hl7.org/fhir/StructureDefinition/ContactPoint
    l: ContactPoint
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XTN
mapping:
  identity:
    v: rim
  map:
    v: TEL
mapping:
  identity:
    v: servd
  map:
    v: ContactPoint
mapping:
  identity:
    v: v2
  map:
    v: NK1-5 / NK1-6 / NK1-40
mapping:
  identity:
    v: rim
  map:
    v: telecom

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

id:
  v: RelatedPerson.telecom:phone.extension
path:
  v: RelatedPerson.telecom.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 1
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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

id:
  v: RelatedPerson.telecom:phone.extension:telephoneNumberType
path:
  v: RelatedPerson.telecom.extension
slice name:
  v: telephoneNumberType
short:
  v: Extension MODS Person Telephone Number Type
definition:
  v: MODS type of telephone number, e.g. Carer, Work, Old
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType
    l: Extension-MODS-PersonTelephoneNumberType
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
must support:
  v: true

id:
  v: RelatedPerson.telecom:phone.system
path:
  v: RelatedPerson.telecom.system
short:
  v: phone | fax | email | pager | url | sms | other
definition:
  v: Telecommunications form for contact point - what communications system is required to make use of the contact.
comment:
  v: Note that FHIR strings SHALL NOT exceed 1MB in size
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ContactPoint.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
pattern: Code
  v: phone
condition:
  v: ele-1
condition:
  v: cpt-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ContactPointSystem
  strength:
    v: required
  description:
    v: Telecommunications form for contact point.
  value set:
    v: http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
    l: http://hl7.org/fhir/ValueSet/contact-point-system
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XTN.3
mapping:
  identity:
    v: rim
  map:
    v: ./scheme
mapping:
  identity:
    v: servd
  map:
    v: ./ContactPointType

id:
  v: RelatedPerson.telecom:phone.system.id
path:
  v: RelatedPerson.telecom.system.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
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.telecom:phone.system.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.telecom.system.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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.telecom:phone.system.extension:otherContactSystem
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.telecom.system.extension
slice name:
  v: otherContactSystem
short:
  v: Other contact system
definition:
  v: Other contact system value which extends the system element in the ContactPoint datatype.
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: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
    l: Extension-UKCore-OtherContactSystem
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.telecom:phone.system.value
path:
  v: RelatedPerson.telecom.system.value
representation:
  v: xmlAttr
short:
  v: Primitive value for code
definition:
  v: Primitive value for code
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  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: code
      l: code
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/regex
      l: regex
    value: String
      v: [^\s]+(\s[^\s]+)*
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
max length:
  v: 1048576

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

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

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

id:
  v: RelatedPerson.telecom:phone.period
path:
  v: RelatedPerson.telecom.period
short:
  v: Time period when the contact point was/is in use
definition:
  v: Time period when the contact point was/is in use.
comment:
  v: A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: per-1
  severity:
    v: error
  human:
    v: If present, start SHALL have a lower value than end
  expression:
    v: start.hasValue().not() or end.hasValue().not() or (start <= end)
  xpath:
    v: not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))
  source:
    v: http://hl7.org/fhir/StructureDefinition/Period
    l: Period
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: DR
mapping:
  identity:
    v: rim
  map:
    v: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: 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.
comment:
  v: Note that FHIR strings SHALL NOT exceed 1MB in size
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
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: rim
  map:
    v: n/a
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: player.birthTime

id:
  v: RelatedPerson.address
path:
  v: RelatedPerson.address
short:
  v: Address where the related person can be contacted or visited
definition:
  v: Address where the related person can be contacted or visited.
comment:
  v: Note: 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](http://hl7.org/fhir/R4/location.html#) 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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD
mapping:
  identity:
    v: rim
  map:
    v: AD
mapping:
  identity:
    v: servd
  map:
    v: Address
mapping:
  identity:
    v: v2
  map:
    v: NK1-4
mapping:
  identity:
    v: rim
  map:
    v: addr

id:
  v: RelatedPerson.address.id
path:
  v: RelatedPerson.address.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
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.address.extension
path:
  v: RelatedPerson.address.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 1
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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

id:
  v: RelatedPerson.address.extension:addressCountry
path:
  v: RelatedPerson.address.extension
slice name:
  v: addressCountry
short:
  v: Extension MODS Address Country
definition:
  v: The country of the patient's place of residence (ISO3166 Countries)
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry
    l: Extension-MODS-AddressCountry
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
must support:
  v: true

id:
  v: RelatedPerson.address.use
path:
  v: RelatedPerson.address.use
short:
  v: home | work | temp | old | billing - purpose of this address
definition:
  v: The purpose of this address.
comment:
  v: Applications can assume that an address is current unless it explicitly says that it is temporary or old.
requirements:
  v: Allows an appropriate address to be chosen from a list of many.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
example:
  label:
    v: General
  value: Code
    v: home
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary or old address 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: AddressUse
  strength:
    v: required
  description:
    v: The use of an address.
  value set:
    v: http://hl7.org/fhir/ValueSet/address-use|4.0.1
    l: http://hl7.org/fhir/ValueSet/address-use
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD.7
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./AddressPurpose

id:
  v: RelatedPerson.address.type
path:
  v: RelatedPerson.address.type
short:
  v: postal | physical | both
definition:
  v: Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
comment:
  v: The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
example:
  label:
    v: General
  value: Code
    v: both
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: AddressType
  strength:
    v: required
  description:
    v: The type of an address (physical / postal).
  value set:
    v: http://hl7.org/fhir/ValueSet/address-type|4.0.1
    l: http://hl7.org/fhir/ValueSet/address-type
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD.18
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: vcard
  map:
    v: address type parameter

id:
  v: RelatedPerson.address.text
path:
  v: RelatedPerson.address.text
short:
  v: Text representation of the address
definition:
  v: Specifies the entire address as it should be displayed e.g. on a postal label. 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 an address 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: Address.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: 137 Nowhere Street, Erewhon 9132
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
mapping:
  identity:
    v: rim
  map:
    v: ./formatted
mapping:
  identity:
    v: vcard
  map:
    v: address label parameter

id:
  v: RelatedPerson.address.line
path:
  v: RelatedPerson.address.line
short:
  v: Street name, number, direction & P.O. Box etc.
definition:
  v: This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
comment:
  v: Note that FHIR strings SHALL NOT exceed 1MB in size
min:
  v: 0
max:
  v: *
base:
  path:
    v: Address.line
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
    l: string
order meaning:
  v: The order in which lines should appear in an address label
example:
  label:
    v: General
  value: String
    v: 137 Nowhere Street
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = AL]
mapping:
  identity:
    v: vcard
  map:
    v: street
mapping:
  identity:
    v: servd
  map:
    v: ./StreetAddress (newline delimitted)

id:
  v: RelatedPerson.address.city
path:
  v: RelatedPerson.address.city
short:
  v: Name of city, town etc.
definition:
  v: The name of the city, town, suburb, village or other community or delivery center.
comment:
  v: Note that FHIR strings SHALL NOT exceed 1MB in size
alias:
  v: Municpality
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.city
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: Erewhon
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD.3
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CTY]
mapping:
  identity:
    v: vcard
  map:
    v: locality
mapping:
  identity:
    v: servd
  map:
    v: ./Jurisdiction

id:
  v: RelatedPerson.address.district
path:
  v: RelatedPerson.address.district
short:
  v: District name (aka county)
definition:
  v: The name of the administrative area (county).
comment:
  v: District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
alias:
  v: County
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.district
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: Madison
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD.9
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CNT | CPA]

id:
  v: RelatedPerson.address.state
path:
  v: RelatedPerson.address.state
short:
  v: Sub-unit of country (abbreviations ok)
definition:
  v: Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
comment:
  v: Note that FHIR strings SHALL NOT exceed 1MB in size
alias:
  v: Province
alias:
  v: Territory
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.state
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD.4
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = STA]
mapping:
  identity:
    v: vcard
  map:
    v: region
mapping:
  identity:
    v: servd
  map:
    v: ./Region

id:
  v: RelatedPerson.address.postalCode
path:
  v: RelatedPerson.address.postalCode
short:
  v: Postal code for area
definition:
  v: A postal code designating a region defined by the postal service.
comment:
  v: Note that FHIR strings SHALL NOT exceed 1MB in size
alias:
  v: Zip
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.postalCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: 9132
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD.5
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = ZIP]
mapping:
  identity:
    v: vcard
  map:
    v: code
mapping:
  identity:
    v: servd
  map:
    v: ./PostalIdentificationCode

id:
  v: RelatedPerson.address.country
path:
  v: RelatedPerson.address.country
short:
  v: Country (e.g. can be ISO 3166 2 or 3 letter code)
definition:
  v: Country - a nation as commonly understood or generally accepted.
comment:
  v: ISO 3166 3 letter codes can be used in place of a human readable country name.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.country
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD.6
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CNT]
mapping:
  identity:
    v: vcard
  map:
    v: country
mapping:
  identity:
    v: servd
  map:
    v: ./Country

id:
  v: RelatedPerson.address.period
path:
  v: RelatedPerson.address.period
short:
  v: Time period when address was/is in use
definition:
  v: Time period when address was/is in use.
comment:
  v: A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration).
requirements:
  v: Allows addresses to be placed in historical context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
example:
  label:
    v: General
  value: Period
    start:
      v: 2010-03-23
    end:
      v: 2010-07-01
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: per-1
  severity:
    v: error
  human:
    v: If present, start SHALL have a lower value than end
  expression:
    v: start.hasValue().not() or end.hasValue().not() or (start <= end)
  xpath:
    v: not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))
  source:
    v: http://hl7.org/fhir/StructureDefinition/Period
    l: Period
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: DR
mapping:
  identity:
    v: rim
  map:
    v: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
mapping:
  identity:
    v: v2
  map:
    v: XAD.12 / XAD.13 + XAD.14
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: RelatedPerson.photo
path:
  v: RelatedPerson.photo
short:
  v: Image of the person
definition:
  v: Image of the person.
comment:
  v: When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: att-1
  severity:
    v: error
  human:
    v: If the Attachment has data, it SHALL have a contentType
  expression:
    v: data.empty() or contentType.exists()
  xpath:
    v: not(exists(f:data)) or exists(f:contentType)
  source:
    v: http://hl7.org/fhir/StructureDefinition/Attachment
    l: Attachment
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: ED/RP
mapping:
  identity:
    v: rim
  map:
    v: ED
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.
comment:
  v: A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: per-1
  severity:
    v: error
  human:
    v: If present, start SHALL have a lower value than end
  expression:
    v: start.hasValue().not() or end.hasValue().not() or (start <= end)
  xpath:
    v: not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))
  source:
    v: http://hl7.org/fhir/StructureDefinition/Period
    l: Period
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: DR
mapping:
  identity:
    v: rim
  map:
    v: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
mapping:
  identity:
    v: rim
  map:
    v: n/a
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
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.communication.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
    l: structuredefinition-normative-version
  value: Code
    v: 4.0.0
path:
  v: RelatedPerson.communication.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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
mapping:
  identity:
    v: rim
  map:
    v: n/a
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    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
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: 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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
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: required
  description:
    v: A language which may be used to communicate with the related person about the patient's health.
  value set:
    v: http://hl7.org/fhir/ValueSet/all-languages
    l: all-languages
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CE/CNE/CWE
mapping:
  identity:
    v: rim
  map:
    v: CD
mapping:
  identity:
    v: orim
  map:
    v: fhir:CodeableConcept rdfs:subClassOf dt:CD
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: preferenceInd

element:
  id:
    v: RelatedPerson
  path:
    v: RelatedPerson
element:
  id:
    v: RelatedPerson.extension:organisation
  path:
    v: RelatedPerson.extension
  slice name:
    v: organisation
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
      l: Extension-MODS-PersonCareProvider
element:
  id:
    v: RelatedPerson.telecom
  path:
    v: RelatedPerson.telecom
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: system
    rules:
      v: open
element:
  id:
    v: RelatedPerson.telecom:email
  path:
    v: RelatedPerson.telecom
  slice name:
    v: email
  min:
    v: 0
  max:
    v: *
element:
  id:
    v: RelatedPerson.telecom:email.extension
  path:
    v: RelatedPerson.telecom.extension
  min:
    v: 1
element:
  id:
    v: RelatedPerson.telecom:email.extension:emailAddressType
  path:
    v: RelatedPerson.telecom.extension
  slice name:
    v: emailAddressType
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType
      l: Extension-MODS-PersonEmailAddressType
  must support:
    v: true
element:
  id:
    v: RelatedPerson.telecom:email.system
  path:
    v: RelatedPerson.telecom.system
  min:
    v: 1
  pattern: Code
    v: email
element:
  id:
    v: RelatedPerson.telecom:email.value
  path:
    v: RelatedPerson.telecom.value
  min:
    v: 1
element:
  id:
    v: RelatedPerson.telecom:phone
  path:
    v: RelatedPerson.telecom
  slice name:
    v: phone
  min:
    v: 0
  max:
    v: *
element:
  id:
    v: RelatedPerson.telecom:phone.extension
  path:
    v: RelatedPerson.telecom.extension
  min:
    v: 1
element:
  id:
    v: RelatedPerson.telecom:phone.extension:telephoneNumberType
  path:
    v: RelatedPerson.telecom.extension
  slice name:
    v: telephoneNumberType
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType
      l: Extension-MODS-PersonTelephoneNumberType
  must support:
    v: true
element:
  id:
    v: RelatedPerson.telecom:phone.system
  path:
    v: RelatedPerson.telecom.system
  min:
    v: 1
  pattern: Code
    v: phone
element:
  id:
    v: RelatedPerson.telecom:phone.value
  path:
    v: RelatedPerson.telecom.value
  min:
    v: 1
element:
  id:
    v: RelatedPerson.address.extension
  path:
    v: RelatedPerson.address.extension
  min:
    v: 1
element:
  id:
    v: RelatedPerson.address.extension:addressCountry
  path:
    v: RelatedPerson.address.extension
  slice name:
    v: addressCountry
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry
      l: Extension-MODS-AddressCountry
  must support:
    v: true