CH ELM (R4)
1.3.0 - release Switzerland flag

This page is part of the Observations of notifiable communicable infectious diseases (v1.3.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: ChElmPatient - Detailed Descriptions

Active as of 2024-05-17

Definitions for the ch-elm-patient resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Patient
ShortCH ELM Patient
LOINC Code
2. Patient.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..2
Must Supporttrue
LOINC Code
4. Patient.identifier:EPR-SPID
Slice NameEPR-SPID
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
LOINC Code
6. Patient.identifier:AHVN13
Slice NameAHVN13
ShortOASI Number Switzerland
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
Must Supporttrue
LOINC Code
8. Patient.identifier:LocalPid
Slice NameLocalPid
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
LOINC Code
10. Patient.identifier:insuranceCardNumber
Slice NameinsuranceCardNumber
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
LOINC Code
12. Patient.identifier:IDN
Slice NameIDN
ShortIDN Liechtenstein
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier(IDN Identifier)
Must Supporttrue
Pattern Value{
  "system" : "urn:oid:2.16.438.10.20.10.10.1.2.1"
}
14. Patient.name
ShortWhether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)'
Control1..1
TypeHumanName(Human Name)
LOINC Code
16. Patient.name.family
ShortIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
Control1..?
Max Length:100
18. Patient.name.given
ShortIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
Control1..1
Max Length:100
20. Patient.telecom:phone
Slice Namephone
Control0..1
LOINC Code
22. Patient.telecom:phone.value
Max Length:25
Example<br/><b>CH ELM</b>:+41 79 999 55 66
24. Patient.gender
Control1..?
LOINC Code
26. Patient.birthDate
Control1..?
Invariantsch-elm-dateTime: At least the format YYYY-MM-DD is required. ($this.toString().length() >= 10)
LOINC Code
28. Patient.address
Control0..1
Must Supporttrue
LOINC Code
SlicingThis element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ use
  • 30. Patient.address:home
    Slice Namehome
    ShortResidential address
    Control0..1
    Must Supporttrue
    32. Patient.address:home.use
    Control1..?
    Pattern Valuehome
    34. Patient.address:home.line
    Control0..1
    36. Patient.address:home.line.extension
    Control1..?
    38. Patient.address:home.line.extension:streetName
    Slice NamestreetName
    Control1..?
    40. Patient.address:home.line.extension:streetName.value[x]
    [x] NoteSee Choice of Data Types for further information about how to use [x]
    Max Length:100
    42. Patient.address:home.line.extension:houseNumber
    Slice NamehouseNumber
    Must Supporttrue
    44. Patient.address:home.line.extension:houseNumber.value[x]
    [x] NoteSee Choice of Data Types for further information about how to use [x]
    Max Length:10
    46. Patient.address:home.city
    Must Supporttrue
    Max Length:50
    48. Patient.address:home.state
    Must Supporttrue
    50. Patient.address:home.postalCode
    Must Supporttrue
    Max Length:10
    52. Patient.address:home.country
    Must Supporttrue
    54. Patient.address:home.country.extension
    Control1..?
    56. Patient.address:home.country.extension:countrycode
    Slice Namecountrycode
    Control1..?

    Guidance on how to interpret the contents of this table can be found here

    0. Patient
    Definition

    The CH Core Patient is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements in Switzerland. See also https://www.bfs.admin.ch/bfs/de/home/register/personenregister/registerharmonisierung/nomenklaturen.html for further information


    Demographics and other administrative information about an individual or animal receiving care or other health-related services.

    ShortCH ELM PatientInformation about an individual or animal receiving health care services
    Control0..*
    Is Modifierfalse
    Summaryfalse
    Alternate NamesSubjectOfCare Client Resident
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-3: 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 (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())
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    ch-pat-1: At least one HumanName with given and family name must be provided. (name.where(family.exists() and given.exists()).count()>0 or name.empty())
    ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR (gender.empty() or gender!='unknown')
    ch-lab-pat1: The resource should be conform to the corresponding EU LAB profile (conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Patient-eu-lab'))
    2. Patient.implicitRules
    Definition

    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.

    ShortA set of rules under which this content was created
    Comments

    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.

    Control0..1
    Typeuri
    Is Modifiertrue because 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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. Patient.extension:placeOfBirth
    Slice NameplaceOfBirth
    Definition

    The registered place of birth of the patient.

    ShortPlace of birth of patient
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Place of Birth according to eCH-0011) (Extension Type: Address(Address for Place of Birth))
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    LOINC Code
    6. Patient.extension:placeOfOrigin
    Slice NameplaceOfOrigin
    Definition

    The registered place of origin of the patient.

    ShortPlace of origin(s) of patient
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Place of Origin according to eCH-0011) (Extension Type: Address)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    LOINC Code
    8. Patient.extension:citizenship
    Slice Namecitizenship
    Definition

    The content of the country code element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, if the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.

    ShortCitizenship(s) of patient
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(citizenship) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code (((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))
    LOINC Code
    10. Patient.extension:religion
    Slice Namereligion
    Definition

    The patient's professed religious affiliations.

    ShortReligion of patient
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(religion) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    LOINC Code
    12. Patient.modifierExtension
    Definition

    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).

    ShortExtensions that cannot be ignored
    Comments

    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    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.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Patient.identifier
    Definition

    An identifier for this patient.

    ShortAn identifier for this patient
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..2*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Patients are almost always assigned specific numerical identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • pattern @ $this
    • 16. Patient.identifier:EPR-SPID
      Slice NameEPR-SPID
      Definition

      An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.


      An identifier for this patient.

      ShortAn identifier intended for computationAn identifier for this patient
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..0*
      This element is affected by the following invariants: ele-1
      TypeIdentifier(EPR-SPID Identifier)
      Is Modifierfalse
      Requirements

      Patients are almost always assigned specific numerical identifiers.

      Pattern Value{
        "system" : "urn:oid:2.16.756.5.30.1.127.3.10.3"
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Patient.identifier:AHVN13
      Slice NameAHVN13
      Definition

      An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.


      An identifier for this patient.

      ShortOASI Number SwitzerlandAn identifier for this patient
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1*
      This element is affected by the following invariants: ele-1
      TypeIdentifier(AHVN13 / NAVS13 Identifier)
      Is Modifierfalse
      Must Supporttrue
      Requirements

      Patients are almost always assigned specific numerical identifiers.

      Pattern Value{
        "system" : "urn:oid:2.16.756.5.32"
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Patient.identifier:LocalPid
      Slice NameLocalPid
      Definition

      An identifier for this patient.

      ShortLocal patient identifier(s)An identifier for this patient
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..0*
      TypeIdentifier
      Is Modifierfalse
      Summarytrue
      Requirements

      Patients are almost always assigned specific numerical identifiers.

      Pattern Value{
        "type" : {
          "coding" : [{
            "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code" : "MR"
          }]
        }
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Patient.identifier:insuranceCardNumber
      Slice NameinsuranceCardNumber
      Definition

      An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.


      An identifier for this patient.

      ShortAn identifier intended for computationAn identifier for this patient
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..0*
      This element is affected by the following invariants: ele-1
      TypeIdentifier(Insurance Card Number (Identifier))
      Is Modifierfalse
      Requirements

      Patients are almost always assigned specific numerical identifiers.

      Pattern Value{
        "system" : "urn:oid:2.16.756.5.30.1.123.100.1.1.1"
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Patient.identifier:IDN
      Slice NameIDN
      Definition

      An identifier for this patient.

      ShortIDN LiechtensteinAn identifier for this patient
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1*
      TypeIdentifier(IDN Identifier)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Patients are almost always assigned specific numerical identifiers.

      Pattern Value{
        "system" : "urn:oid:2.16.438.10.20.10.10.1.2.1"
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Patient.active
      Definition

      Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

      It is often used to filter patient lists to exclude inactive patients

      Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

      ShortWhether this patient's record is in active use
      Comments

      If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

      Control0..1
      Typeboolean
      Is Modifiertrue because 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
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be able to mark a patient record as not to be used because it was created in error.

      Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Patient.name
      Definition

      A human's name with the ability to identify parts and usage.


      A name associated with the individual.

      ShortWhether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)'A name associated with the patient
      Comments

      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.


      A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

      Control10..1*
      This element is affected by the following invariants: ele-1
      TypeHumanName(Human Name)
      Is Modifierfalse
      Requirements

      Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official'))
      ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden')))
      ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name (descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count())
      ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name (descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count())
      30. Patient.name.extension:vctcode
      Slice Namevctcode
      Definition

      This CH ELM extension enables to proivde the VCT Code.

      ShortCH ELM Extension: VCT Code
      Control0..1
      TypeExtension(CH ELM Extension: VCT code) (Extension Type: string)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      LOINC Code
      32. Patient.name.extension:hivcode
      Slice Namehivcode
      Definition

      This CH ELM extension enables to proivde the HIV Code.

      ShortCH ELM Extension: HIV Code
      Control0..1
      TypeExtension(CH ELM Extension: HIV code) (Extension Type: string)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      LOINC Code
      34. Patient.name.use
      Definition

      Identifies the purpose for this name.

      Shortusual | official | temp | nickname | anonymous | old | maiden
      Comments

      Applications can assume that a name is current unless it explicitly says that it is temporary or old.

      Control0..1
      BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

      The use of a human name.

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate name for a particular context of use to be selected from among a set of names.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. Patient.name.family
      Definition

      The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

      ShortIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)Family name (often called 'Surname')
      Comments

      Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Alternate Namessurname
      Max Length:100
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. Patient.name.family.extension:ech11name
      Slice Nameech11name
      Definition

      Extension for eCH-0011 - namedatatype

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Name) (Extension Type: code)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      LOINC Code
      40. Patient.name.family.extension:dataabsentreason
      Slice Namedataabsentreason
      Definition

      Provides a reason why the expected value or elements in the element that is extended are missing.

      Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
      Control0..1
      TypeExtension(Why value is missing) (Extension Type: code)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      LOINC Code
      42. Patient.name.given
      Definition

      Given name.

      ShortIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)Given names (not always 'first'). Includes middle names
      Comments

      If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

      Control10..1*
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Alternate Namesfirst name, middle name
      Max Length:100
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. Patient.name.given.extension:ech11firstname
      Slice Nameech11firstname
      Definition

      eCH-0011: Extension to define first name type

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(First Name) (Extension Type: code)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      LOINC Code
      46. Patient.name.given.extension:dataabsentreason
      Slice Namedataabsentreason
      Definition

      Provides a reason why the expected value or elements in the element that is extended are missing.

      Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
      Control0..1
      TypeExtension(Why value is missing) (Extension Type: code)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      LOINC Code
      48. Patient.telecom
      Definition

      A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

      ShortA contact detail for the individual
      Comments

      A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

      Control0..*
      TypeContactPoint
      Is Modifierfalse
      Summarytrue
      Requirements

      People have (primary) ways to contact them in some way such as phone, email.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ system
      • 50. Patient.telecom:email
        Slice Nameemail
        Definition

        Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


        A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

        ShortCH Core ContactPoint eCH-0046 EmailA contact detail for the individual
        Comments

        A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeContactPoint(CH Core ContactPoint eCH-0046 Email)
        Is Modifierfalse
        Requirements

        People have (primary) ways to contact them in some way such as phone, email.

        Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Patient.telecom:phone
        Slice Namephone
        Definition

        Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


        A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

        ShortCH Core ContactPoint eCH-0046 PhoneA contact detail for the individual
        Comments

        A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

        Control0..1*
        This element is affected by the following invariants: ele-1
        TypeContactPoint(CH Core ContactPoint eCH-0046 Phone)
        Is Modifierfalse
        Requirements

        People have (primary) ways to contact them in some way such as phone, email.

        Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. Patient.telecom:phone.system
        Definition

        Telecommunications form for contact point - what communications system is required to make use of the contact.

        Shortphone | fax | email | pager | url | sms | other
        Control10..1
        This element is affected by the following invariants: cpt-2
        BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

        Telecommunications form for contact point.

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Fixed Valuephone
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. Patient.telecom:phone.value
        Definition

        The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

        ShortThe actual contact point details
        Comments

        Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

        Control10..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Need to support legacy numbers that are not in a tightly controlled format.

        Max Length:25
        Example<br/><b>CH ELM</b>:+41 79 999 55 66
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Patient.telecom:phone.use
        Definition

        Identifies the purpose for the contact point.

        Shorthome | work | temp | old | mobile - purpose of this contact point
        Comments

        Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

        Control0..1
        BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

        Use of contact point.

        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. Patient.telecom:phone.use.extension:phoneCategory
        Slice NamephoneCategory
        Definition

        Optional Extension Element - found in all resources.

        ShortOptional Extensions Element
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(eCH-0046 Phone Category) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        LOINC Code
        62. Patient.telecom:internet
        Slice Nameinternet
        Definition

        Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


        A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

        ShortCH Core ContactPoint eCH-0046 InternetA contact detail for the individual
        Comments

        A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeContactPoint(CH Core ContactPoint eCH-0046 Internet)
        Is Modifierfalse
        Requirements

        People have (primary) ways to contact them in some way such as phone, email.

        Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        64. Patient.gender
        Definition

        Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

        Shortmale | female | othermale | female | other | unknown
        Comments

        The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

        Control10..1
        BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
        (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

        The gender of a person used for administrative purposes.

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Needed for identification of the individual, in combination with (at least) name and birth date.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        66. Patient.birthDate
        Definition

        The date of birth for the individual.

        ShortThe date of birth for the individual
        Comments

        At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

        Control10..1
        Typedate
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Age of the individual drives many clinical processes.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ch-elm-dateTime: At least the format YYYY-MM-DD is required. ($this.toString().length() >= 10)
        LOINC Code21112-8
        68. Patient.deceased[x]
        Definition

        Indicates if the individual is deceased or not.

        ShortIndicates if the individual is deceased or not
        Comments

        If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

        Control0..1
        TypeChoice of: boolean, dateTime
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. Patient.address
        Definition

        An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.


        An address for the individual.

        ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)An address for the individual
        Comments

        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 resource).


        Patient may have multiple addresses with different uses or applicable periods.

        Control0..1*
        This element is affected by the following invariants: ele-1
        TypeAddress(CH Core Address)
        Is Modifierfalse
        Must Supporttrue
        Requirements

        May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))))
        SlicingThis element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ use
        • 72. Patient.address:home
          Slice Namehome
          Definition

          An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.


          An address for the individual.

          ShortResidential addressAn address for the individual
          Comments

          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 resource).


          Patient may have multiple addresses with different uses or applicable periods.

          Control0..1*
          This element is affected by the following invariants: ele-1
          TypeAddress(CH Core Address)
          Is Modifierfalse
          Must Supporttrue
          Requirements

          May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))))
          74. Patient.address:home.use
          Definition

          The purpose of this address.

          Shorthome | work | temp | old | billing - purpose of this address
          Comments

          Applications can assume that an address is current unless it explicitly says that it is temporary or old.

          Control10..1
          BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
          (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

          The use of an address.

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows an appropriate address to be chosen from a list of many.

          Pattern Valuehome
          Example<br/><b>General</b>:home
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          76. Patient.address:home.line
          Definition

          This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

          ShortStreet name, number, direction & P.O. Box etc.
          Control0..1*
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Example<br/><b>General</b>:137 Nowhere Street
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          78. Patient.address:home.line.extension
          Definition

          An Extension


          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.

          ShortExtensionAdditional content defined by implementations
          Comments

          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.

          Control10..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Patient.address.line.extension. The slices areOrderedUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • value @ value
          • 80. Patient.address:home.line.extension:addressLine1
            Slice NameaddressLine1
            Definition

            eCH-0010: Extension to define line types for an address

            ShortExtension
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(Address Line Type) (Extension Type: code)
            Is Modifierfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            LOINC Code
            82. Patient.address:home.line.extension:addressLine1.extension
            Definition

            An Extension


            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.

            ShortExtensionAdditional content defined by implementations
            Comments

            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.

            Control0..0*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 84. Patient.address:home.line.extension:addressLine1.url
              Definition

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies the meaning of the extension
              Comments

              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
              86. Patient.address:home.line.extension:addressLine1.value[x]
              Definition

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              ShortValue of extension
              Control10..1
              Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
              [x] NoteSee Choice of Data Types for further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
              • type @ $this
              • 88. Patient.address:home.line.extension:addressLine1.value[x]:valueCode
                Slice NamevalueCode
                Definition

                Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).


                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                ShortValue of extension
                Control10..1
                BindingUnless not suitable, these codes SHALL be taken from For codes, see eCH-010 Address Line Type
                (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                A set of codes advising a system or user which name in a set of names to select for a given purpose.

                Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                [x] NoteSee Choice of Data Types for further information about how to use [x]
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Fixed ValueaddressLine1
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                90. Patient.address:home.line.extension:addressLine2
                Slice NameaddressLine2
                Definition

                eCH-0010: Extension to define line types for an address

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Address Line Type) (Extension Type: code)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                LOINC Code
                92. Patient.address:home.line.extension:addressLine2.extension
                Definition

                An Extension


                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.

                ShortExtensionAdditional content defined by implementations
                Comments

                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.

                Control0..0*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 94. Patient.address:home.line.extension:addressLine2.url
                  Definition

                  Source of the definition for the extension code - a logical name or a URL.

                  Shortidentifies the meaning of the extension
                  Comments

                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
                  96. Patient.address:home.line.extension:addressLine2.value[x]
                  Definition

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                  ShortValue of extension
                  Control10..1
                  Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                  [x] NoteSee Choice of Data Types for further information about how to use [x]
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                  • type @ $this
                  • 98. Patient.address:home.line.extension:addressLine2.value[x]:valueCode
                    Slice NamevalueCode
                    Definition

                    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).


                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                    ShortValue of extension
                    Control10..1
                    BindingUnless not suitable, these codes SHALL be taken from For codes, see eCH-010 Address Line Type
                    (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                    A set of codes advising a system or user which name in a set of names to select for a given purpose.

                    Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Fixed ValueaddressLine2
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    100. Patient.address:home.line.extension:street
                    Slice Namestreet
                    Definition

                    eCH-0010: Extension to define line types for an address

                    ShortExtension
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(Address Line Type) (Extension Type: code)
                    Is Modifierfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    LOINC Code
                    102. Patient.address:home.line.extension:street.extension
                    Definition

                    An Extension


                    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.

                    ShortExtensionAdditional content defined by implementations
                    Comments

                    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.

                    Control0..0*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 104. Patient.address:home.line.extension:street.url
                      Definition

                      Source of the definition for the extension code - a logical name or a URL.

                      Shortidentifies the meaning of the extension
                      Comments

                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
                      106. Patient.address:home.line.extension:street.value[x]
                      Definition

                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                      ShortValue of extension
                      Control10..1
                      Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                      [x] NoteSee Choice of Data Types for further information about how to use [x]
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                      • type @ $this
                      • 108. Patient.address:home.line.extension:street.value[x]:valueCode
                        Slice NamevalueCode
                        Definition

                        Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).


                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                        ShortValue of extension
                        Control10..1
                        BindingUnless not suitable, these codes SHALL be taken from For codes, see eCH-010 Address Line Type
                        (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                        A set of codes advising a system or user which name in a set of names to select for a given purpose.

                        Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                        [x] NoteSee Choice of Data Types for further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Fixed Valuestreet
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        110. Patient.address:home.line.extension:streetName
                        Slice NamestreetName
                        Definition

                        streetName.

                        ShortstreetName
                        Control1..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(ADXP-streetName) (Extension Type: string)
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        LOINC Code
                        112. Patient.address:home.line.extension:streetName.extension
                        Definition

                        An Extension


                        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.

                        ShortExtensionAdditional content defined by implementations
                        Comments

                        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.

                        Control0..0*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 114. Patient.address:home.line.extension:streetName.url
                          Definition

                          Source of the definition for the extension code - a logical name or a URL.

                          Shortidentifies the meaning of the extension
                          Comments

                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                          Control1..1
                          Typeuri
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
                          116. Patient.address:home.line.extension:streetName.value[x]
                          Definition

                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).


                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                          ShortValue of extension
                          Control10..1
                          Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summaryfalse
                          Max Length:100
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          118. Patient.address:home.line.extension:houseNumber
                          Slice NamehouseNumber
                          Definition

                          The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

                          ShorthouseNumber
                          Control0..1
                          This element is affected by the following invariants: ele-1
                          TypeExtension(ADXP-houseNumber) (Extension Type: string)
                          Is Modifierfalse
                          Must Supporttrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          LOINC Code
                          120. Patient.address:home.line.extension:houseNumber.extension
                          Definition

                          An Extension


                          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.

                          ShortExtensionAdditional content defined by implementations
                          Comments

                          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.

                          Control0..0*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 122. Patient.address:home.line.extension:houseNumber.url
                            Definition

                            Source of the definition for the extension code - a logical name or a URL.

                            Shortidentifies the meaning of the extension
                            Comments

                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
                            124. Patient.address:home.line.extension:houseNumber.value[x]
                            Definition

                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).


                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                            ShortValue of extension
                            Control10..1
                            Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                            [x] NoteSee Choice of Data Types for further information about how to use [x]
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Max Length:10
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            126. Patient.address:home.line.extension:unitID
                            Slice NameunitID
                            Definition

                            The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

                            ShortunitID, dwellingNumber part of the street line
                            Control0..1
                            This element is affected by the following invariants: ele-1
                            TypeExtension(ADXP-unitID) (Extension Type: string)
                            Is Modifierfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            LOINC Code
                            128. Patient.address:home.line.extension:postOfficeBoxText
                            Slice NamepostOfficeBoxText
                            Definition

                            eCH-0010: Extension to define line types for an address

                            ShortPostbox addresses need an postbox text and optional postbox number
                            Control0..1
                            This element is affected by the following invariants: ele-1
                            TypeExtension(Address Line Type) (Extension Type: code)
                            Is Modifierfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            LOINC Code
                            130. Patient.address:home.line.extension:postOfficeBoxText.extension
                            Definition

                            An Extension


                            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.

                            ShortExtensionAdditional content defined by implementations
                            Comments

                            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.

                            Control0..0*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 132. Patient.address:home.line.extension:postOfficeBoxText.url
                              Definition

                              Source of the definition for the extension code - a logical name or a URL.

                              Shortidentifies the meaning of the extension
                              Comments

                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                              Control1..1
                              Typeuri
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
                              134. Patient.address:home.line.extension:postOfficeBoxText.value[x]
                              Definition

                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                              ShortValue of extension
                              Control10..1
                              Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                              [x] NoteSee Choice of Data Types for further information about how to use [x]
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                              • type @ $this
                              • 136. Patient.address:home.line.extension:postOfficeBoxText.value[x]:valueCode
                                Slice NamevalueCode
                                Definition

                                Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).


                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                ShortValue of extension
                                Control10..1
                                BindingUnless not suitable, these codes SHALL be taken from For codes, see eCH-010 Address Line Type
                                (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                                A set of codes advising a system or user which name in a set of names to select for a given purpose.

                                Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                [x] NoteSee Choice of Data Types for further information about how to use [x]
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Fixed ValuepostOfficeBoxText
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                138. Patient.address:home.line.extension:postOfficeBoxNumber
                                Slice NamepostOfficeBoxNumber
                                Definition

                                A numbered box located in a post station.

                                ShortOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(ADXP-postBox) (Extension Type: string)
                                Is Modifierfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                LOINC Code
                                140. Patient.address:home.city
                                Definition

                                The name of the city, town, suburb, village or other community or delivery center.

                                ShortName of city, town etc.
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                Alternate NamesMunicpality
                                Max Length:50
                                Example<br/><b>General</b>:Erewhon
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                142. Patient.address:home.city.extension:bfs
                                Slice Namebfs
                                Definition

                                Extension for eCH-0011 - bfs number (ministry of statistics number)

                                ShortExtension
                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(eCH-0007 Municipality Id – BFS Gemeindenummer) (Extension Type: string)
                                Is Modifierfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                LOINC Code
                                144. Patient.address:home.state
                                Definition

                                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).

                                ShortSub-unit of country (abbreviations ok)
                                Control0..1
                                BindingFor example codes, see For codes, see eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein)
                                (example to http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation)

                                Use these values for a Swiss or Liechtenstein address

                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                Alternate NamesProvince, Territory
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                146. Patient.address:home.postalCode
                                Definition

                                A postal code designating a region defined by the postal service.

                                ShortPostal code for area
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                Alternate NamesZip
                                Max Length:10
                                Example<br/><b>General</b>:9132
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                148. Patient.address:home.country
                                Definition

                                Country - a nation as commonly understood or generally accepted.

                                ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                                Comments

                                ISO 3166 3 letter codes can be used in place of a human readable country name.

                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                150. Patient.address:home.country.extension
                                Definition

                                An Extension


                                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.

                                ShortExtensionAdditional content defined by implementations
                                Comments

                                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.

                                Control10..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                SlicingThis element introduces a set of slices on Patient.address.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 152. Patient.address:home.country.extension:countrycode
                                  Slice Namecountrycode
                                  Definition

                                  Provides a coded expression for the content represented in a string.

                                  Shortcode for string
                                  Control1..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(SC-coding) (Extension Type: Coding)
                                  Is Modifierfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code (((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  LOINC Code
                                  154. Patient.contact
                                  Definition

                                  A contact party (e.g. guardian, partner, friend) for the patient.

                                  ShortA contact party (e.g. guardian, partner, friend) for the patient
                                  Comments

                                  Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                  Control0..*
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  Summaryfalse
                                  Requirements

                                  Need to track people you can contact about the patient.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                  pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                  SlicingThis element introduces a set of slices on Patient.contact. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ relationship
                                  • 156. Patient.contact.modifierExtension
                                    Definition

                                    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).

                                    ShortExtensions that cannot be ignored even if unrecognized
                                    Comments

                                    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.

                                    Control0..*
                                    TypeExtension
                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                    Summarytrue
                                    Requirements

                                    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.

                                    Alternate Namesextensions, user content, modifiers
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    158. Patient.contact:contact
                                    Slice Namecontact
                                    Definition

                                    A contact party (e.g. guardian, partner, friend) for the patient.

                                    ShortContact data if it is not address of patientA contact party (e.g. guardian, partner, friend) for the patient
                                    Comments

                                    Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                    Control0..1*
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    Need to track people you can contact about the patient.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                    pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                    160. Patient.contact:contact.modifierExtension
                                    Definition

                                    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).

                                    ShortExtensions that cannot be ignored even if unrecognized
                                    Comments

                                    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.

                                    Control0..*
                                    TypeExtension
                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                    Summarytrue
                                    Requirements

                                    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.

                                    Alternate Namesextensions, user content, modifiers
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    162. Patient.contact:contact.relationship
                                    Definition

                                    The nature of the relationship between the patient and the contact person.

                                    ShortThe kind of relationship
                                    Control10..1*
                                    BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship
                                    (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                                    The nature of the relationship between a patient and a contact person for that patient.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    Used to determine which contact person is the most relevant to approach, depending on circumstances.

                                    Pattern Value{
                                      "coding" : [{
                                        "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
                                        "code" : "contactData"
                                      }]
                                    }
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    164. Patient.contact:contact.telecom
                                    Definition

                                    A contact detail for the person, e.g. a telephone number or an email address.

                                    ShortA contact detail for the person
                                    Comments

                                    Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                    Control0..0*
                                    TypeContactPoint
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    People have (primary) ways to contact them in some way such as phone, email.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    166. Patient.contact:contact.address
                                    Definition

                                    An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.


                                    Address for the contact person.

                                    ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)Address for the contact person
                                    Comments

                                    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 resource).

                                    Control10..1
                                    This element is affected by the following invariants: ele-1
                                    TypeAddress(CH Core Postal Address)
                                    Is Modifierfalse
                                    Requirements

                                    Need to keep track where the contact person can be contacted per postal mail or visited.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))))
                                    168. Patient.contact:nameOfParent
                                    Slice NamenameOfParent
                                    Definition

                                    A contact party (e.g. guardian, partner, friend) for the patient.

                                    ShortName of parentA contact party (e.g. guardian, partner, friend) for the patient
                                    Comments

                                    Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                    Control0..*
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    Need to track people you can contact about the patient.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                    pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                    170. Patient.contact:nameOfParent.modifierExtension
                                    Definition

                                    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).

                                    ShortExtensions that cannot be ignored even if unrecognized
                                    Comments

                                    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.

                                    Control0..*
                                    TypeExtension
                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                    Summarytrue
                                    Requirements

                                    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.

                                    Alternate Namesextensions, user content, modifiers
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    172. Patient.contact:nameOfParent.relationship
                                    Definition

                                    The nature of the relationship between the patient and the contact person.

                                    ShortThe kind of relationship
                                    Control10..1*
                                    BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship
                                    (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                                    The nature of the relationship between a patient and a contact person for that patient.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    Used to determine which contact person is the most relevant to approach, depending on circumstances.

                                    Pattern Value{
                                      "coding" : [{
                                        "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                        "code" : "PRN"
                                      }]
                                    }
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    174. Patient.contact:nameOfParent.name
                                    Definition

                                    A name associated with the contact person.

                                    ShortA name associated with the contact person
                                    Control10..1
                                    TypeHumanName
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    176. Patient.communication
                                    Definition

                                    A language which may be used to communicate with the patient about his or her health.

                                    ShortA language which may be used to communicate with the patient about his or her health
                                    Comments

                                    If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                    Control0..*
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    SlicingThis element introduces a set of slices on Patient.communication. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ preferred
                                    • 178. Patient.communication.modifierExtension
                                      Definition

                                      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).

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

                                      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.

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                      Summarytrue
                                      Requirements

                                      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.

                                      Alternate Namesextensions, user content, modifiers
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      180. Patient.communication.language
                                      Definition

                                      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.

                                      ShortThe language which can be used to communicate with the patient about his or her health
                                      Comments

                                      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.

                                      Control1..1
                                      BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
                                      (preferred to http://hl7.org/fhir/ValueSet/languages)

                                      A human language.

                                      Additional BindingsPurpose
                                      AllLanguagesMax Binding
                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summaryfalse
                                      Requirements

                                      Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      182. Patient.communication:languageOfCorrespondence
                                      Slice NamelanguageOfCorrespondence
                                      Definition

                                      A language which may be used to communicate with the patient about his or her health.

                                      ShortLanguage of correspondenceA language which may be used to communicate with the patient about his or her health
                                      Comments

                                      If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                      Control0..1*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Summaryfalse
                                      Requirements

                                      If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      184. Patient.communication:languageOfCorrespondence.modifierExtension
                                      Definition

                                      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).

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

                                      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.

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                      Summarytrue
                                      Requirements

                                      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.

                                      Alternate Namesextensions, user content, modifiers
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      186. Patient.communication:languageOfCorrespondence.language
                                      Definition

                                      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.

                                      ShortThe language which can be used to communicate with the patient about his or her health
                                      Comments

                                      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.

                                      Control1..1
                                      BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
                                      (preferred to http://hl7.org/fhir/ValueSet/languages)

                                      A human language.

                                      Additional BindingsPurpose
                                      AllLanguagesMax Binding
                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summaryfalse
                                      Requirements

                                      Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      188. Patient.communication:languageOfCorrespondence.preferred
                                      Definition

                                      Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

                                      ShortLanguage preference indicator
                                      Comments

                                      This language is specifically identified for communicating healthcare information.

                                      Control10..1
                                      Typeboolean
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Requirements

                                      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.

                                      Fixed Valuetrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      190. Patient.link
                                      Definition

                                      Link to another patient resource that concerns the same actual patient.

                                      ShortLink to another patient resource that concerns the same actual person
                                      Comments

                                      There is no assumption that linked patient records have mutual links.

                                      Control0..*
                                      TypeBackboneElement
                                      Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                                      Summarytrue
                                      Requirements

                                      There are multiple use cases:

                                      • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                      • Distribution of patient information across multiple servers.
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      192. Patient.link.modifierExtension
                                      Definition

                                      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).

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

                                      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.

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                      Summarytrue
                                      Requirements

                                      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.

                                      Alternate Namesextensions, user content, modifiers
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      194. Patient.link.other
                                      Definition

                                      The other patient resource that the link refers to.

                                      ShortThe other patient or related person resource that the link refers to
                                      Comments

                                      Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

                                      Control1..1
                                      TypeReference(Patient, RelatedPerson)
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      196. Patient.link.type
                                      Definition

                                      The type of link between this patient resource and another patient resource.

                                      Shortreplaced-by | replaces | refer | seealso
                                      Control1..1
                                      BindingThe codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1
                                      (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

                                      The type of link between this patient resource and another patient resource.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

                                      Guidance on how to interpret the contents of this table can be found here

                                      0. Patient
                                      Definition

                                      The CH Core Patient is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements in Switzerland. See also https://www.bfs.admin.ch/bfs/de/home/register/personenregister/registerharmonisierung/nomenklaturen.html for further information

                                      ShortCH ELM Patient
                                      Control0..*
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate NamesSubjectOfCare Client Resident
                                      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                      dom-3: 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 (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())
                                      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                                      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                      dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                      ch-pat-1: At least one HumanName with given and family name must be provided. (name.where(family.exists() and given.exists()).count()>0 or name.empty())
                                      ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR (gender.empty() or gender!='unknown')
                                      ch-lab-pat1: The resource should be conform to the corresponding EU LAB profile (conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Patient-eu-lab'))
                                      2. Patient.id
                                      Definition

                                      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                                      ShortLogical id of this artifact
                                      Comments

                                      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                                      Control0..1
                                      Typeid
                                      Is Modifierfalse
                                      Summarytrue
                                      4. Patient.meta
                                      Definition

                                      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.

                                      ShortMetadata about the resource
                                      Control0..1
                                      TypeMeta
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      6. Patient.implicitRules
                                      Definition

                                      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.

                                      ShortA set of rules under which this content was created
                                      Comments

                                      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.

                                      Control0..1
                                      Typeuri
                                      Is Modifiertrue because 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
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      8. Patient.language
                                      Definition

                                      The base language in which the resource is written.

                                      ShortLanguage of the resource content
                                      Comments

                                      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).

                                      Control0..1
                                      BindingThe codes SHOULD be taken from CommonLanguages
                                      (preferred to http://hl7.org/fhir/ValueSet/languages)

                                      A human language.

                                      Additional BindingsPurpose
                                      AllLanguagesMax Binding
                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      10. Patient.text
                                      Definition

                                      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.

                                      ShortText summary of the resource, for human interpretation
                                      Comments

                                      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.

                                      Control0..1
                                      TypeNarrative
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesnarrative, html, xhtml, display
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      12. Patient.contained
                                      Definition

                                      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.

                                      ShortContained, inline Resources
                                      Comments

                                      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.

                                      Control0..*
                                      TypeResource
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesinline resources, anonymous resources, contained resources
                                      14. Patient.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      SlicingThis element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 16. Patient.extension:placeOfBirth
                                        Slice NameplaceOfBirth
                                        Definition

                                        The registered place of birth of the patient.

                                        ShortPlace of birth of patient
                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(Place of Birth according to eCH-0011) (Extension Type: Address(Address for Place of Birth))
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        18. Patient.extension:placeOfOrigin
                                        Slice NameplaceOfOrigin
                                        Definition

                                        The registered place of origin of the patient.

                                        ShortPlace of origin(s) of patient
                                        Control0..*
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(Place of Origin according to eCH-0011) (Extension Type: Address)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        20. Patient.extension:citizenship
                                        Slice Namecitizenship
                                        Definition

                                        The content of the country code element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, if the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.

                                        ShortCitizenship(s) of patient
                                        Control0..*
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(citizenship) (Complex Extension)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code (((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))
                                        22. Patient.extension:religion
                                        Slice Namereligion
                                        Definition

                                        The patient's professed religious affiliations.

                                        ShortReligion of patient
                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(religion) (Extension Type: CodeableConcept)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        24. Patient.modifierExtension
                                        Definition

                                        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).

                                        ShortExtensions that cannot be ignored
                                        Comments

                                        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.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                        Summaryfalse
                                        Requirements

                                        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.

                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        26. Patient.identifier
                                        Definition

                                        An identifier for this patient.

                                        ShortAn identifier for this patient
                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control0..2
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summarytrue
                                        Requirements

                                        Patients are almost always assigned specific numerical identifiers.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • pattern @ $this
                                        • 28. Patient.identifier:EPR-SPID
                                          Slice NameEPR-SPID
                                          Definition

                                          An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

                                          ShortAn identifier intended for computation
                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..0
                                          This element is affected by the following invariants: ele-1
                                          TypeIdentifier(EPR-SPID Identifier)
                                          Is Modifierfalse
                                          Requirements

                                          Patients are almost always assigned specific numerical identifiers.

                                          Pattern Value{
                                            "system" : "urn:oid:2.16.756.5.30.1.127.3.10.3"
                                          }
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          30. Patient.identifier:AHVN13
                                          Slice NameAHVN13
                                          Definition

                                          An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

                                          ShortOASI Number Switzerland
                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeIdentifier(AHVN13 / NAVS13 Identifier)
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Requirements

                                          Patients are almost always assigned specific numerical identifiers.

                                          Pattern Value{
                                            "system" : "urn:oid:2.16.756.5.32"
                                          }
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          32. Patient.identifier:LocalPid
                                          Slice NameLocalPid
                                          Definition

                                          An identifier for this patient.

                                          ShortLocal patient identifier(s)
                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..0
                                          TypeIdentifier
                                          Is Modifierfalse
                                          Summarytrue
                                          Requirements

                                          Patients are almost always assigned specific numerical identifiers.

                                          Pattern Value{
                                            "type" : {
                                              "coding" : [{
                                                "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                                "code" : "MR"
                                              }]
                                            }
                                          }
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          34. Patient.identifier:insuranceCardNumber
                                          Slice NameinsuranceCardNumber
                                          Definition

                                          An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

                                          ShortAn identifier intended for computation
                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..0
                                          This element is affected by the following invariants: ele-1
                                          TypeIdentifier(Insurance Card Number (Identifier))
                                          Is Modifierfalse
                                          Requirements

                                          Patients are almost always assigned specific numerical identifiers.

                                          Pattern Value{
                                            "system" : "urn:oid:2.16.756.5.30.1.123.100.1.1.1"
                                          }
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          36. Patient.identifier:IDN
                                          Slice NameIDN
                                          Definition

                                          An identifier for this patient.

                                          ShortIDN Liechtenstein
                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..1
                                          TypeIdentifier(IDN Identifier)
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Patients are almost always assigned specific numerical identifiers.

                                          Pattern Value{
                                            "system" : "urn:oid:2.16.438.10.20.10.10.1.2.1"
                                          }
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          38. Patient.active
                                          Definition

                                          Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

                                          It is often used to filter patient lists to exclude inactive patients

                                          Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

                                          ShortWhether this patient's record is in active use
                                          Comments

                                          If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

                                          Control0..1
                                          Typeboolean
                                          Is Modifiertrue because 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
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          Need to be able to mark a patient record as not to be used because it was created in error.

                                          Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          40. Patient.name
                                          Definition

                                          A human's name with the ability to identify parts and usage.

                                          ShortWhether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)'
                                          Comments

                                          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.

                                          Control1..1
                                          This element is affected by the following invariants: ele-1
                                          TypeHumanName(Human Name)
                                          Is Modifierfalse
                                          Requirements

                                          Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official'))
                                          ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden')))
                                          ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name (descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count())
                                          ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name (descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count())
                                          42. Patient.name.id
                                          Definition

                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          44. Patient.name.extension
                                          Definition

                                          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.

                                          ShortAdditional content defined by implementations
                                          Comments

                                          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.

                                          Control0..*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesextensions, user content
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 46. Patient.name.extension:vctcode
                                            Slice Namevctcode
                                            Definition

                                            This CH ELM extension enables to proivde the VCT Code.

                                            ShortCH ELM Extension: VCT Code
                                            Control0..1
                                            TypeExtension(CH ELM Extension: VCT code) (Extension Type: string)
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            48. Patient.name.extension:hivcode
                                            Slice Namehivcode
                                            Definition

                                            This CH ELM extension enables to proivde the HIV Code.

                                            ShortCH ELM Extension: HIV Code
                                            Control0..1
                                            TypeExtension(CH ELM Extension: HIV code) (Extension Type: string)
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            50. Patient.name.use
                                            Definition

                                            Identifies the purpose for this name.

                                            Shortusual | official | temp | nickname | anonymous | old | maiden
                                            Comments

                                            Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                            Control0..1
                                            BindingThe codes SHALL be taken from NameUse
                                            (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                            The use of a human name.

                                            Typecode
                                            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            52. Patient.name.text
                                            Definition

                                            Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                            ShortText representation of the full name
                                            Comments

                                            Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            A renderable, unencoded form.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            54. Patient.name.family
                                            Definition

                                            The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                            ShortIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
                                            Comments

                                            Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                            Control1..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Alternate Namessurname
                                            Max Length:100
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            56. Patient.name.family.id
                                            Definition

                                            unique id for the element within a resource (for internal references)

                                            Shortxml:id (or equivalent in JSON)
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            58. Patient.name.family.extension
                                            Definition

                                            An Extension

                                            ShortExtension
                                            Control0..*
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            SlicingThis element introduces a set of slices on Patient.name.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 60. Patient.name.family.extension:ech11name
                                              Slice Nameech11name
                                              Definition

                                              Extension for eCH-0011 - namedatatype

                                              ShortExtension
                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension(Name) (Extension Type: code)
                                              Is Modifierfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              62. Patient.name.family.extension:dataabsentreason
                                              Slice Namedataabsentreason
                                              Definition

                                              Provides a reason why the expected value or elements in the element that is extended are missing.

                                              Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
                                              Control0..1
                                              TypeExtension(Why value is missing) (Extension Type: code)
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              64. Patient.name.family.value
                                              Definition

                                              The actual value

                                              ShortPrimitive value for string
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Max Length:1048576
                                              66. Patient.name.given
                                              Definition

                                              Given name.

                                              ShortIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
                                              Comments

                                              If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                              Control1..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Alternate Namesfirst name, middle name
                                              Max Length:100
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              68. Patient.name.given.id
                                              Definition

                                              unique id for the element within a resource (for internal references)

                                              Shortxml:id (or equivalent in JSON)
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              70. Patient.name.given.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              SlicingThis element introduces a set of slices on Patient.name.given.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 72. Patient.name.given.extension:ech11firstname
                                                Slice Nameech11firstname
                                                Definition

                                                eCH-0011: Extension to define first name type

                                                ShortExtension
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(First Name) (Extension Type: code)
                                                Is Modifierfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                74. Patient.name.given.extension:dataabsentreason
                                                Slice Namedataabsentreason
                                                Definition

                                                Provides a reason why the expected value or elements in the element that is extended are missing.

                                                Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
                                                Control0..1
                                                TypeExtension(Why value is missing) (Extension Type: code)
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                76. Patient.name.given.value
                                                Definition

                                                The actual value

                                                ShortPrimitive value for string
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                Max Length:1048576
                                                78. Patient.name.prefix
                                                Definition

                                                Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                ShortFor a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.
                                                Control0..*
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                80. Patient.name.prefix.id
                                                Definition

                                                unique id for the element within a resource (for internal references)

                                                Shortxml:id (or equivalent in JSON)
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                82. Patient.name.prefix.extension
                                                Definition

                                                An Extension

                                                ShortExtension
                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                SlicingThis element introduces a set of slices on Patient.name.prefix.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 84. Patient.name.prefix.extension:salutationandtitle
                                                  Slice Namesalutationandtitle
                                                  Definition

                                                  A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

                                                  ShortFor academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.
                                                  Comments

                                                  Used to indicate additional information about the name part and how it should be used.

                                                  Control0..*
                                                  This element is affected by the following invariants: ele-1
                                                  TypeExtension(EN-qualifier) (Extension Type: code)
                                                  Is Modifierfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  86. Patient.name.prefix.value
                                                  Definition

                                                  The actual value

                                                  ShortPrimitive value for string
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  Max Length:1048576
                                                  88. Patient.name.suffix
                                                  Definition

                                                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                  ShortParts that come after the name
                                                  Control0..*
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  90. Patient.name.period
                                                  Definition

                                                  Indicates the period of time when this name was valid for the named person.

                                                  ShortTime period when name was/is in use
                                                  Control0..1
                                                  TypePeriod
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Requirements

                                                  Allows names to be placed in historical context.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  92. Patient.telecom
                                                  Definition

                                                  A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                  ShortA contact detail for the individual
                                                  Comments

                                                  A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                  Control0..*
                                                  TypeContactPoint
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Requirements

                                                  People have (primary) ways to contact them in some way such as phone, email.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ system
                                                  • 94. Patient.telecom:email
                                                    Slice Nameemail
                                                    Definition

                                                    Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                                                    ShortCH Core ContactPoint eCH-0046 Email
                                                    Comments

                                                    A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                    Control0..*
                                                    This element is affected by the following invariants: ele-1
                                                    TypeContactPoint(CH Core ContactPoint eCH-0046 Email)
                                                    Is Modifierfalse
                                                    Requirements

                                                    People have (primary) ways to contact them in some way such as phone, email.

                                                    Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                                                    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    96. Patient.telecom:phone
                                                    Slice Namephone
                                                    Definition

                                                    Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                                                    ShortCH Core ContactPoint eCH-0046 Phone
                                                    Comments

                                                    A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                    Control0..1
                                                    This element is affected by the following invariants: ele-1
                                                    TypeContactPoint(CH Core ContactPoint eCH-0046 Phone)
                                                    Is Modifierfalse
                                                    Requirements

                                                    People have (primary) ways to contact them in some way such as phone, email.

                                                    Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                                                    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    98. Patient.telecom:phone.id
                                                    Definition

                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                    ShortUnique id for inter-element referencing
                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    100. Patient.telecom:phone.extension
                                                    Definition

                                                    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.

                                                    ShortAdditional content defined by implementations
                                                    Comments

                                                    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.

                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesextensions, user content
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 102. Patient.telecom:phone.system
                                                      Definition

                                                      Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                      Shortphone | fax | email | pager | url | sms | other
                                                      Control1..1
                                                      This element is affected by the following invariants: cpt-2
                                                      BindingThe codes SHALL be taken from ContactPointSystem
                                                      (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                      Telecommunications form for contact point.

                                                      Typecode
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Fixed Valuephone
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      104. Patient.telecom:phone.value
                                                      Definition

                                                      The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                                      ShortThe actual contact point details
                                                      Comments

                                                      Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                                                      Control1..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      Need to support legacy numbers that are not in a tightly controlled format.

                                                      Max Length:25
                                                      Example<br/><b>CH ELM</b>:+41 79 999 55 66
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      106. Patient.telecom:phone.use
                                                      Definition

                                                      Identifies the purpose for the contact point.

                                                      Shorthome | work | temp | old | mobile - purpose of this contact point
                                                      Comments

                                                      Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                      Control0..1
                                                      BindingThe codes SHALL be taken from ContactPointUse
                                                      (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                                                      Use of contact point.

                                                      Typecode
                                                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      108. Patient.telecom:phone.use.id
                                                      Definition

                                                      unique id for the element within a resource (for internal references)

                                                      Shortxml:id (or equivalent in JSON)
                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      110. Patient.telecom:phone.use.extension
                                                      Definition

                                                      An Extension

                                                      ShortExtension
                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      SlicingThis element introduces a set of slices on Patient.telecom.use.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 112. Patient.telecom:phone.use.extension:phoneCategory
                                                        Slice NamephoneCategory
                                                        Definition

                                                        Optional Extension Element - found in all resources.

                                                        ShortOptional Extensions Element
                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(eCH-0046 Phone Category) (Extension Type: CodeableConcept)
                                                        Is Modifierfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        114. Patient.telecom:phone.use.value
                                                        Definition

                                                        Primitive value for code

                                                        ShortPrimitive value for code
                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        116. Patient.telecom:phone.rank
                                                        Definition

                                                        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.

                                                        ShortSpecify preferred order of use (1 = highest)
                                                        Comments

                                                        Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                                                        Control0..1
                                                        TypepositiveInt
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        118. Patient.telecom:phone.period
                                                        Definition

                                                        Time period when the contact point was/is in use.

                                                        ShortTime period when the contact point was/is in use
                                                        Control0..1
                                                        TypePeriod
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        120. Patient.telecom:phone.period.id
                                                        Definition

                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                        ShortUnique id for inter-element referencing
                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        122. Patient.telecom:phone.period.extension
                                                        Definition

                                                        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.

                                                        ShortAdditional content defined by implementations
                                                        Comments

                                                        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.

                                                        Control0..*
                                                        TypeExtension
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Alternate Namesextensions, user content
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        SlicingThis element introduces a set of slices on Patient.telecom.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 124. Patient.telecom:phone.period.start
                                                          Definition

                                                          The start of the period. The boundary is inclusive.

                                                          ShortStarting time with inclusive boundary
                                                          Comments

                                                          If the low element is missing, the meaning is that the low boundary is not known.

                                                          Control0..1
                                                          This element is affected by the following invariants: per-1
                                                          TypedateTime
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          126. Patient.telecom:phone.period.end
                                                          Definition

                                                          The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                                          ShortEnd time with inclusive boundary, if not ongoing
                                                          Comments

                                                          The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                                          Control0..1
                                                          This element is affected by the following invariants: per-1
                                                          TypedateTime
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          128. Patient.telecom:internet
                                                          Slice Nameinternet
                                                          Definition

                                                          Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                                                          ShortCH Core ContactPoint eCH-0046 Internet
                                                          Comments

                                                          A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                          Control0..*
                                                          This element is affected by the following invariants: ele-1
                                                          TypeContactPoint(CH Core ContactPoint eCH-0046 Internet)
                                                          Is Modifierfalse
                                                          Requirements

                                                          People have (primary) ways to contact them in some way such as phone, email.

                                                          Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                                                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          130. Patient.gender
                                                          Definition

                                                          Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

                                                          Shortmale | female | other
                                                          Comments

                                                          The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                                                          Control1..1
                                                          BindingThe codes SHALL be taken from AdministrativeGender
                                                          (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                          The gender of a person used for administrative purposes.

                                                          Typecode
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Requirements

                                                          Needed for identification of the individual, in combination with (at least) name and birth date.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          132. Patient.birthDate
                                                          Definition

                                                          The date of birth for the individual.

                                                          ShortThe date of birth for the individual
                                                          Comments

                                                          At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

                                                          Control1..1
                                                          Typedate
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Requirements

                                                          Age of the individual drives many clinical processes.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ch-elm-dateTime: At least the format YYYY-MM-DD is required. ($this.toString().length() >= 10)
                                                          LOINC Code21112-8
                                                          134. Patient.deceased[x]
                                                          Definition

                                                          Indicates if the individual is deceased or not.

                                                          ShortIndicates if the individual is deceased or not
                                                          Comments

                                                          If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                          Control0..1
                                                          TypeChoice of: boolean, dateTime
                                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                          Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Requirements

                                                          The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          136. Patient.address
                                                          Definition

                                                          An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

                                                          ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                                                          Comments

                                                          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 resource).

                                                          Control0..1
                                                          This element is affected by the following invariants: ele-1
                                                          TypeAddress(CH Core Address)
                                                          Is Modifierfalse
                                                          Must Supporttrue
                                                          Requirements

                                                          May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))))
                                                          SlicingThis element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ use
                                                          • 138. Patient.address:home
                                                            Slice Namehome
                                                            Definition

                                                            An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

                                                            ShortResidential address
                                                            Comments

                                                            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 resource).

                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeAddress(CH Core Address)
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Requirements

                                                            May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))))
                                                            140. Patient.address:home.id
                                                            Definition

                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                            ShortUnique id for inter-element referencing
                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            142. Patient.address:home.extension
                                                            Definition

                                                            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.

                                                            ShortAdditional content defined by implementations
                                                            Comments

                                                            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.

                                                            Control0..*
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Alternate Namesextensions, user content
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            SlicingThis element introduces a set of slices on Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 144. Patient.address:home.use
                                                              Definition

                                                              The purpose of this address.

                                                              Shorthome | work | temp | old | billing - purpose of this address
                                                              Comments

                                                              Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                                                              Control1..1
                                                              BindingThe codes SHALL be taken from AddressUse
                                                              (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                                              The use of an address.

                                                              Typecode
                                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              Allows an appropriate address to be chosen from a list of many.

                                                              Pattern Valuehome
                                                              Example<br/><b>General</b>:home
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              146. Patient.address:home.type
                                                              Definition

                                                              Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                                                              Shortpostal | physical | both
                                                              Comments

                                                              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 resource).

                                                              Control0..1
                                                              BindingThe codes SHALL be taken from AddressType
                                                              (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                                                              The type of an address (physical / postal).

                                                              Typecode
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Example<br/><b>General</b>:both
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              148. Patient.address:home.text
                                                              Definition

                                                              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.

                                                              ShortText representation of the address
                                                              Comments

                                                              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.

                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              A renderable, unencoded form.

                                                              Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              150. Patient.address:home.line
                                                              Definition

                                                              This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                                              ShortStreet name, number, direction & P.O. Box etc.
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Example<br/><b>General</b>:137 Nowhere Street
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              152. Patient.address:home.line.id
                                                              Definition

                                                              unique id for the element within a resource (for internal references)

                                                              Shortxml:id (or equivalent in JSON)
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              154. Patient.address:home.line.extension
                                                              Definition

                                                              An Extension

                                                              ShortExtension
                                                              Control1..*
                                                              TypeExtension
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              SlicingThis element introduces a set of slices on Patient.address.line.extension. The slices areOrdered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • value @ value
                                                              • 156. Patient.address:home.line.extension:addressLine1
                                                                Slice NameaddressLine1
                                                                Definition

                                                                eCH-0010: Extension to define line types for an address

                                                                ShortExtension
                                                                Control0..1
                                                                This element is affected by the following invariants: ele-1
                                                                TypeExtension(Address Line Type) (Extension Type: code)
                                                                Is Modifierfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                158. Patient.address:home.line.extension:addressLine1.id
                                                                Definition

                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                ShortUnique id for inter-element referencing
                                                                Control0..1
                                                                Typestring
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                160. Patient.address:home.line.extension:addressLine1.extension
                                                                Definition

                                                                An Extension

                                                                ShortExtension
                                                                Control0..0
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 162. Patient.address:home.line.extension:addressLine1.url
                                                                  Definition

                                                                  Source of the definition for the extension code - a logical name or a URL.

                                                                  Shortidentifies the meaning of the extension
                                                                  Comments

                                                                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                  Control1..1
                                                                  Typeuri
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
                                                                  164. Patient.address:home.line.extension:addressLine1.value[x]
                                                                  Definition

                                                                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                  ShortValue of extension
                                                                  Control1..1
                                                                  Typecode
                                                                  [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                  • type @ $this
                                                                  • 166. Patient.address:home.line.extension:addressLine1.value[x]:valueCode
                                                                    Slice NamevalueCode
                                                                    Definition

                                                                    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                                                                    ShortValue of extension
                                                                    Control1..1
                                                                    BindingUnless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
                                                                    (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                                                                    A set of codes advising a system or user which name in a set of names to select for a given purpose.

                                                                    Typecode
                                                                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summaryfalse
                                                                    Fixed ValueaddressLine1
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    168. Patient.address:home.line.extension:addressLine2
                                                                    Slice NameaddressLine2
                                                                    Definition

                                                                    eCH-0010: Extension to define line types for an address

                                                                    ShortExtension
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    TypeExtension(Address Line Type) (Extension Type: code)
                                                                    Is Modifierfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    170. Patient.address:home.line.extension:addressLine2.id
                                                                    Definition

                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    172. Patient.address:home.line.extension:addressLine2.extension
                                                                    Definition

                                                                    An Extension

                                                                    ShortExtension
                                                                    Control0..0
                                                                    TypeExtension
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                    • value @ url
                                                                    • 174. Patient.address:home.line.extension:addressLine2.url
                                                                      Definition

                                                                      Source of the definition for the extension code - a logical name or a URL.

                                                                      Shortidentifies the meaning of the extension
                                                                      Comments

                                                                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                      Control1..1
                                                                      Typeuri
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
                                                                      176. Patient.address:home.line.extension:addressLine2.value[x]
                                                                      Definition

                                                                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                      ShortValue of extension
                                                                      Control1..1
                                                                      Typecode
                                                                      [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summaryfalse
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                      • type @ $this
                                                                      • 178. Patient.address:home.line.extension:addressLine2.value[x]:valueCode
                                                                        Slice NamevalueCode
                                                                        Definition

                                                                        Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                                                                        ShortValue of extension
                                                                        Control1..1
                                                                        BindingUnless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
                                                                        (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                                                                        A set of codes advising a system or user which name in a set of names to select for a given purpose.

                                                                        Typecode
                                                                        [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summaryfalse
                                                                        Fixed ValueaddressLine2
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        180. Patient.address:home.line.extension:street
                                                                        Slice Namestreet
                                                                        Definition

                                                                        eCH-0010: Extension to define line types for an address

                                                                        ShortExtension
                                                                        Control0..1
                                                                        This element is affected by the following invariants: ele-1
                                                                        TypeExtension(Address Line Type) (Extension Type: code)
                                                                        Is Modifierfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        182. Patient.address:home.line.extension:street.id
                                                                        Definition

                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                        ShortUnique id for inter-element referencing
                                                                        Control0..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        184. Patient.address:home.line.extension:street.extension
                                                                        Definition

                                                                        An Extension

                                                                        ShortExtension
                                                                        Control0..0
                                                                        TypeExtension
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 186. Patient.address:home.line.extension:street.url
                                                                          Definition

                                                                          Source of the definition for the extension code - a logical name or a URL.

                                                                          Shortidentifies the meaning of the extension
                                                                          Comments

                                                                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                          Control1..1
                                                                          Typeuri
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
                                                                          188. Patient.address:home.line.extension:street.value[x]
                                                                          Definition

                                                                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                          ShortValue of extension
                                                                          Control1..1
                                                                          Typecode
                                                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                          • type @ $this
                                                                          • 190. Patient.address:home.line.extension:street.value[x]:valueCode
                                                                            Slice NamevalueCode
                                                                            Definition

                                                                            Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                                                                            ShortValue of extension
                                                                            Control1..1
                                                                            BindingUnless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
                                                                            (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                                                                            A set of codes advising a system or user which name in a set of names to select for a given purpose.

                                                                            Typecode
                                                                            [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Summaryfalse
                                                                            Fixed Valuestreet
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            192. Patient.address:home.line.extension:streetName
                                                                            Slice NamestreetName
                                                                            Definition

                                                                            streetName.

                                                                            ShortstreetName
                                                                            Control1..1
                                                                            This element is affected by the following invariants: ele-1
                                                                            TypeExtension(ADXP-streetName) (Extension Type: string)
                                                                            Is Modifierfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            194. Patient.address:home.line.extension:streetName.id
                                                                            Definition

                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            196. Patient.address:home.line.extension:streetName.extension
                                                                            Definition

                                                                            An Extension

                                                                            ShortExtension
                                                                            Control0..0
                                                                            TypeExtension
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 198. Patient.address:home.line.extension:streetName.url
                                                                              Definition

                                                                              Source of the definition for the extension code - a logical name or a URL.

                                                                              Shortidentifies the meaning of the extension
                                                                              Comments

                                                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                              Control1..1
                                                                              Typeuri
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
                                                                              200. Patient.address:home.line.extension:streetName.value[x]
                                                                              Definition

                                                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                              ShortValue of extension
                                                                              Control1..1
                                                                              Typestring
                                                                              [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summaryfalse
                                                                              Max Length:100
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              202. Patient.address:home.line.extension:houseNumber
                                                                              Slice NamehouseNumber
                                                                              Definition

                                                                              The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

                                                                              ShorthouseNumber
                                                                              Control0..1
                                                                              This element is affected by the following invariants: ele-1
                                                                              TypeExtension(ADXP-houseNumber) (Extension Type: string)
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              204. Patient.address:home.line.extension:houseNumber.id
                                                                              Definition

                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              206. Patient.address:home.line.extension:houseNumber.extension
                                                                              Definition

                                                                              An Extension

                                                                              ShortExtension
                                                                              Control0..0
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 208. Patient.address:home.line.extension:houseNumber.url
                                                                                Definition

                                                                                Source of the definition for the extension code - a logical name or a URL.

                                                                                Shortidentifies the meaning of the extension
                                                                                Comments

                                                                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                Control1..1
                                                                                Typeuri
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
                                                                                210. Patient.address:home.line.extension:houseNumber.value[x]
                                                                                Definition

                                                                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                ShortValue of extension
                                                                                Control1..1
                                                                                Typestring
                                                                                [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summaryfalse
                                                                                Max Length:10
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                212. Patient.address:home.line.extension:unitID
                                                                                Slice NameunitID
                                                                                Definition

                                                                                The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

                                                                                ShortunitID, dwellingNumber part of the street line
                                                                                Control0..1
                                                                                This element is affected by the following invariants: ele-1
                                                                                TypeExtension(ADXP-unitID) (Extension Type: string)
                                                                                Is Modifierfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                214. Patient.address:home.line.extension:postOfficeBoxText
                                                                                Slice NamepostOfficeBoxText
                                                                                Definition

                                                                                eCH-0010: Extension to define line types for an address

                                                                                ShortPostbox addresses need an postbox text and optional postbox number
                                                                                Control0..1
                                                                                This element is affected by the following invariants: ele-1
                                                                                TypeExtension(Address Line Type) (Extension Type: code)
                                                                                Is Modifierfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                216. Patient.address:home.line.extension:postOfficeBoxText.id
                                                                                Definition

                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                218. Patient.address:home.line.extension:postOfficeBoxText.extension
                                                                                Definition

                                                                                An Extension

                                                                                ShortExtension
                                                                                Control0..0
                                                                                TypeExtension
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                • value @ url
                                                                                • 220. Patient.address:home.line.extension:postOfficeBoxText.url
                                                                                  Definition

                                                                                  Source of the definition for the extension code - a logical name or a URL.

                                                                                  Shortidentifies the meaning of the extension
                                                                                  Comments

                                                                                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                  Control1..1
                                                                                  Typeuri
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
                                                                                  222. Patient.address:home.line.extension:postOfficeBoxText.value[x]
                                                                                  Definition

                                                                                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                  ShortValue of extension
                                                                                  Control1..1
                                                                                  Typecode
                                                                                  [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                  • type @ $this
                                                                                  • 224. Patient.address:home.line.extension:postOfficeBoxText.value[x]:valueCode
                                                                                    Slice NamevalueCode
                                                                                    Definition

                                                                                    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                                                                                    ShortValue of extension
                                                                                    Control1..1
                                                                                    BindingUnless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
                                                                                    (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                                                                                    A set of codes advising a system or user which name in a set of names to select for a given purpose.

                                                                                    Typecode
                                                                                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summaryfalse
                                                                                    Fixed ValuepostOfficeBoxText
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    226. Patient.address:home.line.extension:postOfficeBoxNumber
                                                                                    Slice NamepostOfficeBoxNumber
                                                                                    Definition

                                                                                    A numbered box located in a post station.

                                                                                    ShortOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
                                                                                    Control0..1
                                                                                    This element is affected by the following invariants: ele-1
                                                                                    TypeExtension(ADXP-postBox) (Extension Type: string)
                                                                                    Is Modifierfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    228. Patient.address:home.line.value
                                                                                    Definition

                                                                                    The actual value

                                                                                    ShortPrimitive value for string
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    Max Length:1048576
                                                                                    230. Patient.address:home.city
                                                                                    Definition

                                                                                    The name of the city, town, suburb, village or other community or delivery center.

                                                                                    ShortName of city, town etc.
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Must Supporttrue
                                                                                    Summarytrue
                                                                                    Alternate NamesMunicpality
                                                                                    Max Length:50
                                                                                    Example<br/><b>General</b>:Erewhon
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    232. Patient.address:home.city.id
                                                                                    Definition

                                                                                    unique id for the element within a resource (for internal references)

                                                                                    Shortxml:id (or equivalent in JSON)
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    234. Patient.address:home.city.extension
                                                                                    Definition

                                                                                    An Extension

                                                                                    ShortExtension
                                                                                    Control0..*
                                                                                    TypeExtension
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    SlicingThis element introduces a set of slices on Patient.address.city.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                    • value @ url
                                                                                    • 236. Patient.address:home.city.extension:bfs
                                                                                      Slice Namebfs
                                                                                      Definition

                                                                                      Extension for eCH-0011 - bfs number (ministry of statistics number)

                                                                                      ShortExtension
                                                                                      Control0..1
                                                                                      This element is affected by the following invariants: ele-1
                                                                                      TypeExtension(eCH-0007 Municipality Id – BFS Gemeindenummer) (Extension Type: string)
                                                                                      Is Modifierfalse
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                      238. Patient.address:home.city.value
                                                                                      Definition

                                                                                      The actual value

                                                                                      ShortPrimitive value for string
                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      Max Length:1048576
                                                                                      240. Patient.address:home.district
                                                                                      Definition

                                                                                      The name of the administrative area (county).

                                                                                      ShortDistrict name (aka county)
                                                                                      Comments

                                                                                      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.

                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Alternate NamesCounty
                                                                                      Example<br/><b>General</b>:Madison
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      242. Patient.address:home.state
                                                                                      Definition

                                                                                      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).

                                                                                      ShortSub-unit of country (abbreviations ok)
                                                                                      Control0..1
                                                                                      BindingFor example codes, see eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein)
                                                                                      (example to http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation)

                                                                                      Use these values for a Swiss or Liechtenstein address

                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Alternate NamesProvince, Territory
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      244. Patient.address:home.postalCode
                                                                                      Definition

                                                                                      A postal code designating a region defined by the postal service.

                                                                                      ShortPostal code for area
                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Alternate NamesZip
                                                                                      Max Length:10
                                                                                      Example<br/><b>General</b>:9132
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      246. Patient.address:home.country
                                                                                      Definition

                                                                                      Country - a nation as commonly understood or generally accepted.

                                                                                      ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                                                                                      Comments

                                                                                      ISO 3166 3 letter codes can be used in place of a human readable country name.

                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      248. Patient.address:home.country.id
                                                                                      Definition

                                                                                      unique id for the element within a resource (for internal references)

                                                                                      Shortxml:id (or equivalent in JSON)
                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      250. Patient.address:home.country.extension
                                                                                      Definition

                                                                                      An Extension

                                                                                      ShortExtension
                                                                                      Control1..*
                                                                                      TypeExtension
                                                                                      Is Modifierfalse
                                                                                      Summaryfalse
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                      SlicingThis element introduces a set of slices on Patient.address.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                      • value @ url
                                                                                      • 252. Patient.address:home.country.extension:countrycode
                                                                                        Slice Namecountrycode
                                                                                        Definition

                                                                                        Provides a coded expression for the content represented in a string.

                                                                                        Shortcode for string
                                                                                        Control1..1
                                                                                        This element is affected by the following invariants: ele-1
                                                                                        TypeExtension(SC-coding) (Extension Type: Coding)
                                                                                        Is Modifierfalse
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                        ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code (((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))
                                                                                        254. Patient.address:home.country.value
                                                                                        Definition

                                                                                        The actual value

                                                                                        ShortPrimitive value for string
                                                                                        Control0..1
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        Max Length:1048576
                                                                                        256. Patient.address:home.period
                                                                                        Definition

                                                                                        Time period when address was/is in use.

                                                                                        ShortTime period when address was/is in use
                                                                                        Control0..1
                                                                                        TypePeriod
                                                                                        Is Modifierfalse
                                                                                        Summarytrue
                                                                                        Requirements

                                                                                        Allows addresses to be placed in historical context.

                                                                                        Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        258. Patient.maritalStatus
                                                                                        Definition

                                                                                        This field contains a patient's most recent marital (civil) status.

                                                                                        ShortMarital (civil) status of a patient
                                                                                        Control0..1
                                                                                        BindingUnless not suitable, these codes SHALL be taken from ChCoreMaritalStatus
                                                                                        (extensible to http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus)
                                                                                        TypeCodeableConcept
                                                                                        Is Modifierfalse
                                                                                        Summaryfalse
                                                                                        Requirements

                                                                                        Most, if not all systems capture it.

                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        260. Patient.maritalStatus.id
                                                                                        Definition

                                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                        ShortUnique id for inter-element referencing
                                                                                        Control0..1
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        262. Patient.maritalStatus.extension
                                                                                        Definition

                                                                                        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.

                                                                                        ShortAdditional content defined by implementations
                                                                                        Comments

                                                                                        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.

                                                                                        Control0..*
                                                                                        TypeExtension
                                                                                        Is Modifierfalse
                                                                                        Summaryfalse
                                                                                        Alternate Namesextensions, user content
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                        SlicingThis element introduces a set of slices on Patient.maritalStatus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                        • value @ url
                                                                                        • 264. Patient.maritalStatus.extension:maritalDataSeparation
                                                                                          Slice NamemaritalDataSeparation
                                                                                          Definition

                                                                                          Extension for eCH-0011 - MaritalData - separation

                                                                                          ShortMaritalData Separation
                                                                                          Control0..1
                                                                                          TypeExtension(Marital Data - Separation Type) (Extension Type: CodeableConcept)
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          266. Patient.maritalStatus.coding
                                                                                          Definition

                                                                                          A reference to a code defined by a terminology system.

                                                                                          ShortCode defined by a terminology system
                                                                                          Comments

                                                                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                          Control0..*
                                                                                          TypeCoding
                                                                                          Is Modifierfalse
                                                                                          Summarytrue
                                                                                          Requirements

                                                                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          268. Patient.maritalStatus.text
                                                                                          Definition

                                                                                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                          ShortPlain text representation of the concept
                                                                                          Comments

                                                                                          Very often the text is the same as a displayName of one of the codings.

                                                                                          Control0..1
                                                                                          Typestring
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Requirements

                                                                                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          270. Patient.multipleBirth[x]
                                                                                          Definition

                                                                                          Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                                          ShortWhether patient is part of a multiple birth
                                                                                          Comments

                                                                                          Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                                          Control0..1
                                                                                          TypeChoice of: boolean, integer
                                                                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summaryfalse
                                                                                          Requirements

                                                                                          For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          272. Patient.photo
                                                                                          Definition

                                                                                          Image of the patient.

                                                                                          ShortImage of the patient
                                                                                          Comments

                                                                                          Guidelines:

                                                                                          • Use id photos, not clinical photos.
                                                                                          • Limit dimensions to thumbnail.
                                                                                          • Keep byte count low to ease resource updates.
                                                                                          Control0..*
                                                                                          TypeAttachment
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Requirements

                                                                                          Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          274. Patient.contact
                                                                                          Definition

                                                                                          A contact party (e.g. guardian, partner, friend) for the patient.

                                                                                          ShortA contact party (e.g. guardian, partner, friend) for the patient
                                                                                          Comments

                                                                                          Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                                                                          Control0..*
                                                                                          TypeBackboneElement
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Requirements

                                                                                          Need to track people you can contact about the patient.

                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                                          SlicingThis element introduces a set of slices on Patient.contact. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                          • value @ relationship
                                                                                          • 276. Patient.contact.id
                                                                                            Definition

                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                            ShortUnique id for inter-element referencing
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            278. Patient.contact.extension
                                                                                            Definition

                                                                                            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.

                                                                                            ShortAdditional content defined by implementations
                                                                                            Comments

                                                                                            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.

                                                                                            Control0..*
                                                                                            TypeExtension
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Alternate Namesextensions, user content
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            280. Patient.contact.modifierExtension
                                                                                            Definition

                                                                                            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).

                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                            Comments

                                                                                            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.

                                                                                            Control0..*
                                                                                            TypeExtension
                                                                                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                            Summarytrue
                                                                                            Requirements

                                                                                            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.

                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            282. Patient.contact.relationship
                                                                                            Definition

                                                                                            The nature of the relationship between the patient and the contact person.

                                                                                            ShortThe kind of relationship
                                                                                            Control0..*
                                                                                            BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationship
                                                                                            (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                                                                                            The nature of the relationship between a patient and a contact person for that patient.

                                                                                            TypeCodeableConcept
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Used to determine which contact person is the most relevant to approach, depending on circumstances.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            284. Patient.contact.name
                                                                                            Definition

                                                                                            A name associated with the contact person.

                                                                                            ShortA name associated with the contact person
                                                                                            Control0..1
                                                                                            TypeHumanName
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            286. Patient.contact.telecom
                                                                                            Definition

                                                                                            A contact detail for the person, e.g. a telephone number or an email address.

                                                                                            ShortA contact detail for the person
                                                                                            Comments

                                                                                            Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                                                                            Control0..*
                                                                                            TypeContactPoint
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            People have (primary) ways to contact them in some way such as phone, email.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            288. Patient.contact.address
                                                                                            Definition

                                                                                            Address for the contact person.

                                                                                            ShortAddress for the contact person
                                                                                            Control0..1
                                                                                            TypeAddress
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Need to keep track where the contact person can be contacted per postal mail or visited.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            290. Patient.contact.gender
                                                                                            Definition

                                                                                            Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

                                                                                            Shortmale | female | other | unknown
                                                                                            Control0..1
                                                                                            BindingThe codes SHALL be taken from AdministrativeGender
                                                                                            (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                                                            The gender of a person used for administrative purposes.

                                                                                            Typecode
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Needed to address the person correctly.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            292. Patient.contact.organization
                                                                                            Definition

                                                                                            Organization on behalf of which the contact is acting or for which the contact is working.

                                                                                            ShortOrganization that is associated with the contact
                                                                                            Control0..1
                                                                                            This element is affected by the following invariants: pat-1
                                                                                            TypeReference(Organization)
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            For guardians or business related contacts, the organization is relevant.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            294. Patient.contact.period
                                                                                            Definition

                                                                                            The period during which this contact person or organization is valid to be contacted relating to this patient.

                                                                                            ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                                                                                            Control0..1
                                                                                            TypePeriod
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            296. Patient.contact:contact
                                                                                            Slice Namecontact
                                                                                            Definition

                                                                                            A contact party (e.g. guardian, partner, friend) for the patient.

                                                                                            ShortContact data if it is not address of patient
                                                                                            Comments

                                                                                            Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                                                                            Control0..1
                                                                                            TypeBackboneElement
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Need to track people you can contact about the patient.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                                            298. Patient.contact:contact.id
                                                                                            Definition

                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                            ShortUnique id for inter-element referencing
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            300. Patient.contact:contact.extension
                                                                                            Definition

                                                                                            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.

                                                                                            ShortAdditional content defined by implementations
                                                                                            Comments

                                                                                            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.

                                                                                            Control0..*
                                                                                            TypeExtension
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Alternate Namesextensions, user content
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            302. Patient.contact:contact.modifierExtension
                                                                                            Definition

                                                                                            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).

                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                            Comments

                                                                                            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.

                                                                                            Control0..*
                                                                                            TypeExtension
                                                                                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                            Summarytrue
                                                                                            Requirements

                                                                                            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.

                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            304. Patient.contact:contact.relationship
                                                                                            Definition

                                                                                            The nature of the relationship between the patient and the contact person.

                                                                                            ShortThe kind of relationship
                                                                                            Control1..1
                                                                                            BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationship
                                                                                            (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                                                                                            The nature of the relationship between a patient and a contact person for that patient.

                                                                                            TypeCodeableConcept
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Used to determine which contact person is the most relevant to approach, depending on circumstances.

                                                                                            Pattern Value{
                                                                                              "coding" : [{
                                                                                                "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
                                                                                                "code" : "contactData"
                                                                                              }]
                                                                                            }
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            306. Patient.contact:contact.name
                                                                                            Definition

                                                                                            A name associated with the contact person.

                                                                                            ShortA name associated with the contact person
                                                                                            Control0..1
                                                                                            TypeHumanName
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            308. Patient.contact:contact.telecom
                                                                                            Definition

                                                                                            A contact detail for the person, e.g. a telephone number or an email address.

                                                                                            ShortA contact detail for the person
                                                                                            Comments

                                                                                            Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                                                                            Control0..0
                                                                                            TypeContactPoint
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            People have (primary) ways to contact them in some way such as phone, email.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            310. Patient.contact:contact.address
                                                                                            Definition

                                                                                            An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

                                                                                            ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                                                                                            Comments

                                                                                            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 resource).

                                                                                            Control1..1
                                                                                            This element is affected by the following invariants: ele-1
                                                                                            TypeAddress(CH Core Postal Address)
                                                                                            Is Modifierfalse
                                                                                            Requirements

                                                                                            Need to keep track where the contact person can be contacted per postal mail or visited.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))))
                                                                                            312. Patient.contact:contact.gender
                                                                                            Definition

                                                                                            Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

                                                                                            Shortmale | female | other | unknown
                                                                                            Control0..1
                                                                                            BindingThe codes SHALL be taken from AdministrativeGender
                                                                                            (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                                                            The gender of a person used for administrative purposes.

                                                                                            Typecode
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Needed to address the person correctly.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            314. Patient.contact:contact.organization
                                                                                            Definition

                                                                                            Organization on behalf of which the contact is acting or for which the contact is working.

                                                                                            ShortOrganization that is associated with the contact
                                                                                            Control0..1
                                                                                            This element is affected by the following invariants: pat-1
                                                                                            TypeReference(Organization)
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            For guardians or business related contacts, the organization is relevant.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            316. Patient.contact:contact.period
                                                                                            Definition

                                                                                            The period during which this contact person or organization is valid to be contacted relating to this patient.

                                                                                            ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                                                                                            Control0..1
                                                                                            TypePeriod
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            318. Patient.contact:nameOfParent
                                                                                            Slice NamenameOfParent
                                                                                            Definition

                                                                                            A contact party (e.g. guardian, partner, friend) for the patient.

                                                                                            ShortName of parent
                                                                                            Comments

                                                                                            Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                                                                            Control0..*
                                                                                            TypeBackboneElement
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Need to track people you can contact about the patient.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                                            320. Patient.contact:nameOfParent.id
                                                                                            Definition

                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                            ShortUnique id for inter-element referencing
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            322. Patient.contact:nameOfParent.extension
                                                                                            Definition

                                                                                            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.

                                                                                            ShortAdditional content defined by implementations
                                                                                            Comments

                                                                                            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.

                                                                                            Control0..*
                                                                                            TypeExtension
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Alternate Namesextensions, user content
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            324. Patient.contact:nameOfParent.modifierExtension
                                                                                            Definition

                                                                                            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).

                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                            Comments

                                                                                            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.

                                                                                            Control0..*
                                                                                            TypeExtension
                                                                                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                            Summarytrue
                                                                                            Requirements

                                                                                            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.

                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            326. Patient.contact:nameOfParent.relationship
                                                                                            Definition

                                                                                            The nature of the relationship between the patient and the contact person.

                                                                                            ShortThe kind of relationship
                                                                                            Control1..1
                                                                                            BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationship
                                                                                            (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                                                                                            The nature of the relationship between a patient and a contact person for that patient.

                                                                                            TypeCodeableConcept
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Used to determine which contact person is the most relevant to approach, depending on circumstances.

                                                                                            Pattern Value{
                                                                                              "coding" : [{
                                                                                                "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                                                                                "code" : "PRN"
                                                                                              }]
                                                                                            }
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            328. Patient.contact:nameOfParent.name
                                                                                            Definition

                                                                                            A name associated with the contact person.

                                                                                            ShortA name associated with the contact person
                                                                                            Control1..1
                                                                                            TypeHumanName
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            330. Patient.contact:nameOfParent.telecom
                                                                                            Definition

                                                                                            A contact detail for the person, e.g. a telephone number or an email address.

                                                                                            ShortA contact detail for the person
                                                                                            Comments

                                                                                            Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                                                                            Control0..*
                                                                                            TypeContactPoint
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            People have (primary) ways to contact them in some way such as phone, email.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            332. Patient.contact:nameOfParent.address
                                                                                            Definition

                                                                                            Address for the contact person.

                                                                                            ShortAddress for the contact person
                                                                                            Control0..1
                                                                                            TypeAddress
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Need to keep track where the contact person can be contacted per postal mail or visited.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            334. Patient.contact:nameOfParent.gender
                                                                                            Definition

                                                                                            Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

                                                                                            Shortmale | female | other | unknown
                                                                                            Control0..1
                                                                                            BindingThe codes SHALL be taken from AdministrativeGender
                                                                                            (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                                                            The gender of a person used for administrative purposes.

                                                                                            Typecode
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Needed to address the person correctly.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            336. Patient.contact:nameOfParent.organization
                                                                                            Definition

                                                                                            Organization on behalf of which the contact is acting or for which the contact is working.

                                                                                            ShortOrganization that is associated with the contact
                                                                                            Control0..1
                                                                                            This element is affected by the following invariants: pat-1
                                                                                            TypeReference(Organization)
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            For guardians or business related contacts, the organization is relevant.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            338. Patient.contact:nameOfParent.period
                                                                                            Definition

                                                                                            The period during which this contact person or organization is valid to be contacted relating to this patient.

                                                                                            ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                                                                                            Control0..1
                                                                                            TypePeriod
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            340. Patient.communication
                                                                                            Definition

                                                                                            A language which may be used to communicate with the patient about his or her health.

                                                                                            ShortA language which may be used to communicate with the patient about his or her health
                                                                                            Comments

                                                                                            If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                                            Control0..*
                                                                                            TypeBackboneElement
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            SlicingThis element introduces a set of slices on Patient.communication. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                            • value @ preferred
                                                                                            • 342. Patient.communication.id
                                                                                              Definition

                                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              344. Patient.communication.extension
                                                                                              Definition

                                                                                              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.

                                                                                              ShortAdditional content defined by implementations
                                                                                              Comments

                                                                                              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.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Alternate Namesextensions, user content
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              346. Patient.communication.modifierExtension
                                                                                              Definition

                                                                                              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).

                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                              Comments

                                                                                              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.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                              Summarytrue
                                                                                              Requirements

                                                                                              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.

                                                                                              Alternate Namesextensions, user content, modifiers
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              348. Patient.communication.language
                                                                                              Definition

                                                                                              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.

                                                                                              ShortThe language which can be used to communicate with the patient about his or her health
                                                                                              Comments

                                                                                              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.

                                                                                              Control1..1
                                                                                              BindingThe codes SHOULD be taken from CommonLanguages
                                                                                              (preferred to http://hl7.org/fhir/ValueSet/languages)

                                                                                              A human language.

                                                                                              Additional BindingsPurpose
                                                                                              AllLanguagesMax Binding
                                                                                              TypeCodeableConcept
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              350. Patient.communication.preferred
                                                                                              Definition

                                                                                              Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

                                                                                              ShortLanguage preference indicator
                                                                                              Comments

                                                                                              This language is specifically identified for communicating healthcare information.

                                                                                              Control0..1
                                                                                              Typeboolean
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              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.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              352. Patient.communication:languageOfCorrespondence
                                                                                              Slice NamelanguageOfCorrespondence
                                                                                              Definition

                                                                                              A language which may be used to communicate with the patient about his or her health.

                                                                                              ShortLanguage of correspondence
                                                                                              Comments

                                                                                              If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                                              Control0..1
                                                                                              TypeBackboneElement
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              354. Patient.communication:languageOfCorrespondence.id
                                                                                              Definition

                                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              356. Patient.communication:languageOfCorrespondence.extension
                                                                                              Definition

                                                                                              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.

                                                                                              ShortAdditional content defined by implementations
                                                                                              Comments

                                                                                              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.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Alternate Namesextensions, user content
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              358. Patient.communication:languageOfCorrespondence.modifierExtension
                                                                                              Definition

                                                                                              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).

                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                              Comments

                                                                                              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.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                              Summarytrue
                                                                                              Requirements

                                                                                              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.

                                                                                              Alternate Namesextensions, user content, modifiers
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              360. Patient.communication:languageOfCorrespondence.language
                                                                                              Definition

                                                                                              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.

                                                                                              ShortThe language which can be used to communicate with the patient about his or her health
                                                                                              Comments

                                                                                              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.

                                                                                              Control1..1
                                                                                              BindingThe codes SHOULD be taken from CommonLanguages
                                                                                              (preferred to http://hl7.org/fhir/ValueSet/languages)

                                                                                              A human language.

                                                                                              Additional BindingsPurpose
                                                                                              AllLanguagesMax Binding
                                                                                              TypeCodeableConcept
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              362. Patient.communication:languageOfCorrespondence.preferred
                                                                                              Definition

                                                                                              Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

                                                                                              ShortLanguage preference indicator
                                                                                              Comments

                                                                                              This language is specifically identified for communicating healthcare information.

                                                                                              Control1..1
                                                                                              Typeboolean
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              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.

                                                                                              Fixed Valuetrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              364. Patient.generalPractitioner
                                                                                              Definition

                                                                                              Patient's nominated care provider.

                                                                                              ShortPatient's nominated primary care provider
                                                                                              Comments

                                                                                              This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                                                                                              Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                                                                                              Control0..*
                                                                                              TypeReference(Organization, Practitioner, PractitionerRole)
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Alternate NamescareProvider
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              366. Patient.managingOrganization
                                                                                              Definition

                                                                                              Organization that is the custodian of the patient record.

                                                                                              ShortOrganization that is the custodian of the patient record
                                                                                              Comments

                                                                                              There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                                                                              Control0..1
                                                                                              TypeReference(Organization)
                                                                                              Is Modifierfalse
                                                                                              Summarytrue
                                                                                              Requirements

                                                                                              Need to know who recognizes this patient record, manages and updates it.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              368. Patient.link
                                                                                              Definition

                                                                                              Link to another patient resource that concerns the same actual patient.

                                                                                              ShortLink to another patient resource that concerns the same actual person
                                                                                              Comments

                                                                                              There is no assumption that linked patient records have mutual links.

                                                                                              Control0..*
                                                                                              TypeBackboneElement
                                                                                              Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                                                                                              Summarytrue
                                                                                              Requirements

                                                                                              There are multiple use cases:

                                                                                              • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                                                                              • Distribution of patient information across multiple servers.
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              370. Patient.link.id
                                                                                              Definition

                                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              372. Patient.link.extension
                                                                                              Definition

                                                                                              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.

                                                                                              ShortAdditional content defined by implementations
                                                                                              Comments

                                                                                              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.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Alternate Namesextensions, user content
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              374. Patient.link.modifierExtension
                                                                                              Definition

                                                                                              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).

                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                              Comments

                                                                                              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.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                              Summarytrue
                                                                                              Requirements

                                                                                              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.

                                                                                              Alternate Namesextensions, user content, modifiers
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              376. Patient.link.other
                                                                                              Definition

                                                                                              The other patient resource that the link refers to.

                                                                                              ShortThe other patient or related person resource that the link refers to
                                                                                              Comments

                                                                                              Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

                                                                                              Control1..1
                                                                                              TypeReference(Patient, RelatedPerson)
                                                                                              Is Modifierfalse
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              378. Patient.link.type
                                                                                              Definition

                                                                                              The type of link between this patient resource and another patient resource.

                                                                                              Shortreplaced-by | replaces | refer | seealso
                                                                                              Control1..1
                                                                                              BindingThe codes SHALL be taken from LinkType
                                                                                              (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

                                                                                              The type of link between this patient resource and another patient resource.

                                                                                              Typecode
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))