CH ELM (R4)
1.16.0 - ci-build Switzerland flag

CH ELM (R4), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 1.16.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/ch-elm/ and changes regularly. See the Directory of published versions

Resource Profile: CH ELM Patient HIV

Official URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ChElmPatientHIV Version: 1.16.0
Active as of 2026-10-22 Computable Name: ChElmPatientHIV

Copyright/Legal: CC0-1.0

Patient representation for HIV

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* ChElmPatient CH ELM Patient HIV
This profile also imposes the profile Patient: Person
Constraints: ch-pat-1, ch-pat-2, ch-elm-patient-address-require-countrycode, ch-elm-patient-nameorlocalpid
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of birth of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
Patient.Slices for extension.extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
Patient.Slices for extension.extension:citizenship C 0..* (Complex) Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Slice: Unordered, Open by value:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:AHVN13 This element must be supported. This element is included in summaries. 0..1 AHVN13Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well OASI Number Switzerland

Required Pattern: 
{
  "system" : "urn:oid:2.16.756.5.32"
}
Patient.Slices for identifier.identifier:LocalPid This element is included in summaries. 0..1 Identifier Local patient identifier(s)

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}
Patient.Slices for identifier.identifier:LocalPid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:LocalPid.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:IDN This element must be supported. This element is included in summaries. 0..1 IdnIdentifier IDN Liechtenstein

Required Pattern: 
{
  "system" : "urn:oid:2.16.438.10.20.10.10.1.2.1"
}
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. C 1..1 CHElmHumanName Whether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)'
Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4
Patient.name.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.Slices for extension.extension:hivcode 1..1 string CH ELM Extension: HIV Code
URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element is included in summaries. 1..1 string masked when using HIV/VCT-extensions or unknown (see IG guidance).
Max Length:100
Patient.name.family.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.family.Slices for extension.extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
Patient.name.family.Slices for extension.extension:dataabsentreason 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Patient.name.family.Slices for extension.extension:dataabsentreason.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.name.family.Slices for extension.extension:dataabsentreason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Patient.name.family.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked (extensions allowed)
Patient.name.given This element is included in summaries. 1..1 string masked when using HIV/VCT-extensions or unknown (see IG guidance).
This repeating element order: Given Names appear in the correct order for presenting the name
Max Length:100
Patient.name.given.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.given.Slices for extension.extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
Patient.name.given.Slices for extension.extension:dataabsentreason 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Patient.name.given.Slices for extension.extension:dataabsentreason.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.name.given.Slices for extension.extension:dataabsentreason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Patient.name.given.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked (extensions allowed)
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown* (* see warning 'ch-pat-2')
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:dataabsentreason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.Slices for address This element must be supported. This element is included in summaries. 0..1 CHCoreAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the individual
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for address.address:home This element must be supported. This element is included in summaries. 0..1 CHCoreAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Residential address
Patient.Slices for address.address:home.use This element is a modifier element. This element is included in summaries. 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home (extensions allowed)
Patient.Slices for address.address:home.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Max Length:50
Patient.Slices for address.address:home.city.Slices for extension Content/Rules for all slices
Patient.Slices for address.address:home.city.Slices for extension.extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
Patient.Slices for address.address:home.state This element must be supported. This element is included in summaries. 0..1 string sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address.
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
Patient.Slices for address.address:home.postalCode This element must be supported. This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Max Length:10
Patient.Slices for address.address:home.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for address.address:home.country.Slices for extension Content/Rules for all slices
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode C 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding"
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
Patient.Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
Constraints: pat-1
Patient.Slices for contact.contact:All Slices Content/Rules for all slices
Patient.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact C 0..1 BackboneElement Contact data if it is not the address of the patient
Constraints: pat-1
Patient.Slices for contact.contact:contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact.relationship 1..1 CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
      "code" : "contactData"
    }
  ]
}
Patient.Slices for contact.contact:contact.address 1..1 CHCoreAddressECH10 The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address for the contact person
Patient.Slices for contact.contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
Patient.Slices for contact.contact:nameOfParent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:nameOfParent.relationship 1..1 CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "PRN"
    }
  ]
}
Patient.Slices for contact.contact:nameOfParent.name 1..1 HumanName A name associated with the contact person
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name.family.​extension:dataabsentreason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.name.given.extension:dataabsentreason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​state Base example eCH-0007 Canton Abbreviation 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:country-deprecated.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning Patient.address:home.country.extension:countrycode 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'))
ch-core-hm-1 error Patient.name 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 error Patient.name 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 error Patient.name 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 error Patient.name 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()
ch-elm-patient-address-require-countrycode error Patient patient requires country code in address address.country.all(extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-codedString').exists() or extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').exists())
ch-elm-patient-nameorlocalpid error Patient patient requires either name or local pid, but not both identifier.where(type.coding[0].code='MR').exists() implies name.where(given.hasValue() or family.hasValue()).empty()
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2 warning Patient gender 'unknown' is currently not used in Switzerland in eCH and the EPR gender.empty() or gender!='unknown'
ch-pat-3 warning Patient.extension:citizenship 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'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 error Patient 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 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent 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()

This structure is derived from ChElmPatient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* ChElmPatient CH ELM Patient HIV
This profile also imposes the profile Patient: Person
Patient.identifier 0..1 Identifier An identifier for this patient
Patient.name
Patient.name.extension 1..* Extension Extension
Patient.name.Slices for extension Content/Rules for all slices
Patient.name.Slices for extension.extension:vctcode 0..0 CH ELM Extension: VCT Code
Patient.name.Slices for extension.extension:hivcode 1..1 ChElmExtHivCode CH ELM Extension: HIV Code
Patient.name.family
Patient.name.family.extension 1..* Extension Extension
Patient.name.family.Slices for extension Content/Rules for all slices
Patient.name.family.Slices for extension.extension:dataabsentreason 1..1 DataAbsentReason(5.3.0) unknown | asked | temp | notasked | masked | unsupported | astext | error
Patient.name.family.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Required Pattern: masked (extensions allowed)
Patient.name.given
Patient.name.given.extension 1..* Extension Extension
Patient.name.given.Slices for extension Content/Rules for all slices
Patient.name.given.Slices for extension.extension:dataabsentreason 1..1 DataAbsentReason(5.3.0) unknown | asked | temp | notasked | masked | unsupported | astext | error
Patient.name.given.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Required Pattern: masked (extensions allowed)
Patient.telecom 0..0 A contact detail for the individual
Patient.Slices for telecom.telecom:email 0..0 A contact detail for the individual
Patient.Slices for telecom.telecom:phone 0..0 A contact detail for the individual
Patient.Slices for telecom.telecom:internet 0..0 A contact detail for the individual
Patient.Slices for address Content/Rules for all slices
Patient.Slices for address.address:home 0..1 CHCoreAddress Residential address
Patient.Slices for address.address:home.line 0..0 Street name, number, direction & P.O. Box etc.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* ChElmPatient CH ELM Patient HIV
This profile also imposes the profile Patient: Person
Constraints: ch-pat-1, ch-pat-2, ch-elm-patient-address-require-countrycode, ch-elm-patient-nameorlocalpid
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of birth of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
Patient.Slices for extension.extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
Patient.Slices for extension.extension:citizenship C 0..* (Complex) Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Slice: Unordered, Open by value:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:AHVN13 This element must be supported. This element is included in summaries. 0..1 AHVN13Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well OASI Number Switzerland

Required Pattern: 
{
  "system" : "urn:oid:2.16.756.5.32"
}
Patient.Slices for identifier.identifier:LocalPid This element is included in summaries. 0..1 Identifier Local patient identifier(s)

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}
Patient.Slices for identifier.identifier:LocalPid.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:LocalPid.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:LocalPid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:LocalPid.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:LocalPid.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:LocalPid.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:LocalPid.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:IDN This element must be supported. This element is included in summaries. 0..1 IdnIdentifier IDN Liechtenstein

Required Pattern: 
{
  "system" : "urn:oid:2.16.438.10.20.10.10.1.2.1"
}
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. C 1..1 CHElmHumanName Whether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)'
Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.Slices for extension.extension:hivcode 1..1 string CH ELM Extension: HIV Code
URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element is included in summaries. 1..1 string masked when using HIV/VCT-extensions or unknown (see IG guidance).
Max Length:100
Patient.name.family.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.family.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.family.Slices for extension.extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
Patient.name.family.Slices for extension.extension:dataabsentreason 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Patient.name.family.Slices for extension.extension:dataabsentreason.id 0..1 string Unique id for inter-element referencing
Patient.name.family.Slices for extension.extension:dataabsentreason.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.name.family.Slices for extension.extension:dataabsentreason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Patient.name.family.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked (extensions allowed)
Patient.name.family.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.given This element is included in summaries. 1..1 string masked when using HIV/VCT-extensions or unknown (see IG guidance).
This repeating element order: Given Names appear in the correct order for presenting the name
Max Length:100
Patient.name.given.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.given.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.given.Slices for extension.extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
Patient.name.given.Slices for extension.extension:dataabsentreason 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Patient.name.given.Slices for extension.extension:dataabsentreason.id 0..1 string Unique id for inter-element referencing
Patient.name.given.Slices for extension.extension:dataabsentreason.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.name.given.Slices for extension.extension:dataabsentreason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Patient.name.given.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked (extensions allowed)
Patient.name.given.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.prefix This element is included in summaries. 0..* string For 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.
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.prefix.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.prefix.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.name.prefix.Slices for extension.extension:salutationandtitle 0..* code For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
Patient.name.prefix.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown* (* see warning 'ch-pat-2')
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.birthDate.id 0..1 string xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:dataabsentreason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.birthDate.value 0..1 date Primitive value for date
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.Slices for address This element must be supported. This element is included in summaries. 0..1 CHCoreAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the individual
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for address.address:home This element must be supported. This element is included in summaries. 0..1 CHCoreAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Residential address
Patient.Slices for address.address:home.id 0..1 string Unique id for inter-element referencing
Patient.Slices for address.address:home.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.use This element is a modifier element. This element is included in summaries. 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home (extensions allowed)
Patient.Slices for address.address:home.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.Slices for address.address:home.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for address.address:home.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Max Length:50
Patient.Slices for address.address:home.city.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for address.address:home.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.city.Slices for extension Content/Rules for all slices
Patient.Slices for address.address:home.city.Slices for extension.extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
Patient.Slices for address.address:home.city.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for address.address:home.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.Slices for address.address:home.state This element must be supported. This element is included in summaries. 0..1 string sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address.
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
Patient.Slices for address.address:home.postalCode This element must be supported. This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Max Length:10
Patient.Slices for address.address:home.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for address.address:home.country.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for address.address:home.country.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.country.Slices for extension Content/Rules for all slices
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode C 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.id 0..1 string Unique id for inter-element referencing
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.id 0..1 string Unique id for inter-element referencing
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding"
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
Patient.Slices for address.address:home.country.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for address.address:home.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)
Patient.maritalStatus.id 0..1 string Unique id for inter-element referencing
Patient.maritalStatus.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.maritalStatus.Slices for extension.extension:maritalDataSeparation 0..1 CodeableConcept MaritalData Separation
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation
Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type
Patient.maritalStatus.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.maritalStatus.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
Constraints: pat-1
Patient.Slices for contact.contact:All Slices Content/Rules for all slices
Patient.Slices for contact.contact:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:All Slices.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:All Slices.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.Slices for contact.contact:All Slices.name 0..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:All Slices.telecom 0..* ContactPoint A contact detail for the person
Patient.Slices for contact.contact:All Slices.address 0..1 Address Address for the contact person
Patient.Slices for contact.contact:All Slices.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:All Slices.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:All Slices.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.Slices for contact.contact:contact C 0..1 BackboneElement Contact data if it is not the address of the patient
Constraints: pat-1
Patient.Slices for contact.contact:contact.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:contact.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact.relationship 1..1 CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
      "code" : "contactData"
    }
  ]
}
Patient.Slices for contact.contact:contact.name 0..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:contact.address 1..1 CHCoreAddressECH10 The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address for the contact person
Patient.Slices for contact.contact:contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.Slices for contact.contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
Patient.Slices for contact.contact:nameOfParent.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:nameOfParent.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:nameOfParent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:nameOfParent.relationship 1..1 CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "PRN"
    }
  ]
}
Patient.Slices for contact.contact:nameOfParent.name 1..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:nameOfParent.telecom 0..* ContactPoint A contact detail for the person
Patient.Slices for contact.contact:nameOfParent.address 0..1 Address Address for the contact person
Patient.Slices for contact.contact:nameOfParent.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:nameOfParent.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:nameOfParent.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:LocalPid.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name.family.​extension:dataabsentreason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.name.given.extension:dataabsentreason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​state Base example eCH-0007 Canton Abbreviation 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:country-deprecated.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.maritalStatus Base extensible ChCoreMaritalStatus 📦3.3.0 CH Term v3.3
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:contact.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning Patient.address:home.country.extension:countrycode 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'))
ch-core-hm-1 error Patient.name 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 error Patient.name 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 error Patient.name 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 error Patient.name 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()
ch-elm-patient-address-require-countrycode error Patient patient requires country code in address address.country.all(extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-codedString').exists() or extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').exists())
ch-elm-patient-nameorlocalpid error Patient patient requires either name or local pid, but not both identifier.where(type.coding[0].code='MR').exists() implies name.where(given.hasValue() or family.hasValue()).empty()
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2 warning Patient gender 'unknown' is currently not used in Switzerland in eCH and the EPR gender.empty() or gender!='unknown'
ch-pat-3 warning Patient.extension:citizenship 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'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 error Patient 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 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent 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()

This structure is derived from ChElmPatient

Summary

Mandatory: 6 elements
Prohibited: 6 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* ChElmPatient CH ELM Patient HIV
This profile also imposes the profile Patient: Person
Constraints: ch-pat-1, ch-pat-2, ch-elm-patient-address-require-countrycode, ch-elm-patient-nameorlocalpid
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of birth of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
Patient.Slices for extension.extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
Patient.Slices for extension.extension:citizenship C 0..* (Complex) Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Slice: Unordered, Open by value:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:AHVN13 This element must be supported. This element is included in summaries. 0..1 AHVN13Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well OASI Number Switzerland

Required Pattern: 
{
  "system" : "urn:oid:2.16.756.5.32"
}
Patient.Slices for identifier.identifier:LocalPid This element is included in summaries. 0..1 Identifier Local patient identifier(s)

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}
Patient.Slices for identifier.identifier:LocalPid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:LocalPid.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:IDN This element must be supported. This element is included in summaries. 0..1 IdnIdentifier IDN Liechtenstein

Required Pattern: 
{
  "system" : "urn:oid:2.16.438.10.20.10.10.1.2.1"
}
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. C 1..1 CHElmHumanName Whether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)'
Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4
Patient.name.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.Slices for extension.extension:hivcode 1..1 string CH ELM Extension: HIV Code
URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element is included in summaries. 1..1 string masked when using HIV/VCT-extensions or unknown (see IG guidance).
Max Length:100
Patient.name.family.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.family.Slices for extension.extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
Patient.name.family.Slices for extension.extension:dataabsentreason 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Patient.name.family.Slices for extension.extension:dataabsentreason.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.name.family.Slices for extension.extension:dataabsentreason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Patient.name.family.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked (extensions allowed)
Patient.name.given This element is included in summaries. 1..1 string masked when using HIV/VCT-extensions or unknown (see IG guidance).
This repeating element order: Given Names appear in the correct order for presenting the name
Max Length:100
Patient.name.given.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.given.Slices for extension.extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
Patient.name.given.Slices for extension.extension:dataabsentreason 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Patient.name.given.Slices for extension.extension:dataabsentreason.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.name.given.Slices for extension.extension:dataabsentreason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Patient.name.given.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked (extensions allowed)
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown* (* see warning 'ch-pat-2')
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:dataabsentreason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.Slices for address This element must be supported. This element is included in summaries. 0..1 CHCoreAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the individual
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for address.address:home This element must be supported. This element is included in summaries. 0..1 CHCoreAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Residential address
Patient.Slices for address.address:home.use This element is a modifier element. This element is included in summaries. 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home (extensions allowed)
Patient.Slices for address.address:home.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Max Length:50
Patient.Slices for address.address:home.city.Slices for extension Content/Rules for all slices
Patient.Slices for address.address:home.city.Slices for extension.extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
Patient.Slices for address.address:home.state This element must be supported. This element is included in summaries. 0..1 string sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address.
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
Patient.Slices for address.address:home.postalCode This element must be supported. This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Max Length:10
Patient.Slices for address.address:home.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for address.address:home.country.Slices for extension Content/Rules for all slices
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode C 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding"
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
Patient.Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
Constraints: pat-1
Patient.Slices for contact.contact:All Slices Content/Rules for all slices
Patient.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact C 0..1 BackboneElement Contact data if it is not the address of the patient
Constraints: pat-1
Patient.Slices for contact.contact:contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact.relationship 1..1 CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
      "code" : "contactData"
    }
  ]
}
Patient.Slices for contact.contact:contact.address 1..1 CHCoreAddressECH10 The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address for the contact person
Patient.Slices for contact.contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
Patient.Slices for contact.contact:nameOfParent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:nameOfParent.relationship 1..1 CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "PRN"
    }
  ]
}
Patient.Slices for contact.contact:nameOfParent.name 1..1 HumanName A name associated with the contact person
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name.family.​extension:dataabsentreason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.name.given.extension:dataabsentreason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​state Base example eCH-0007 Canton Abbreviation 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:country-deprecated.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning Patient.address:home.country.extension:countrycode 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'))
ch-core-hm-1 error Patient.name 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 error Patient.name 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 error Patient.name 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 error Patient.name 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()
ch-elm-patient-address-require-countrycode error Patient patient requires country code in address address.country.all(extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-codedString').exists() or extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').exists())
ch-elm-patient-nameorlocalpid error Patient patient requires either name or local pid, but not both identifier.where(type.coding[0].code='MR').exists() implies name.where(given.hasValue() or family.hasValue()).empty()
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2 warning Patient gender 'unknown' is currently not used in Switzerland in eCH and the EPR gender.empty() or gender!='unknown'
ch-pat-3 warning Patient.extension:citizenship 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'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 error Patient 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 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent 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()

Differential View

This structure is derived from ChElmPatient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* ChElmPatient CH ELM Patient HIV
This profile also imposes the profile Patient: Person
Patient.identifier 0..1 Identifier An identifier for this patient
Patient.name
Patient.name.extension 1..* Extension Extension
Patient.name.Slices for extension Content/Rules for all slices
Patient.name.Slices for extension.extension:vctcode 0..0 CH ELM Extension: VCT Code
Patient.name.Slices for extension.extension:hivcode 1..1 ChElmExtHivCode CH ELM Extension: HIV Code
Patient.name.family
Patient.name.family.extension 1..* Extension Extension
Patient.name.family.Slices for extension Content/Rules for all slices
Patient.name.family.Slices for extension.extension:dataabsentreason 1..1 DataAbsentReason(5.3.0) unknown | asked | temp | notasked | masked | unsupported | astext | error
Patient.name.family.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Required Pattern: masked (extensions allowed)
Patient.name.given
Patient.name.given.extension 1..* Extension Extension
Patient.name.given.Slices for extension Content/Rules for all slices
Patient.name.given.Slices for extension.extension:dataabsentreason 1..1 DataAbsentReason(5.3.0) unknown | asked | temp | notasked | masked | unsupported | astext | error
Patient.name.given.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Required Pattern: masked (extensions allowed)
Patient.telecom 0..0 A contact detail for the individual
Patient.Slices for telecom Content/Rules for all slices
Patient.Slices for telecom.telecom:email 0..0 A contact detail for the individual
Patient.Slices for telecom.telecom:phone 0..0 A contact detail for the individual
Patient.Slices for telecom.telecom:internet 0..0 A contact detail for the individual
Patient.Slices for address Content/Rules for all slices
Patient.Slices for address.address:home 0..1 CHCoreAddress Residential address
Patient.Slices for address.address:home.line 0..0 Street name, number, direction & P.O. Box etc.

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* ChElmPatient CH ELM Patient HIV
This profile also imposes the profile Patient: Person
Constraints: ch-pat-1, ch-pat-2, ch-elm-patient-address-require-countrycode, ch-elm-patient-nameorlocalpid
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of birth of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
Patient.Slices for extension.extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
Patient.Slices for extension.extension:citizenship C 0..* (Complex) Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Slice: Unordered, Open by value:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:AHVN13 This element must be supported. This element is included in summaries. 0..1 AHVN13Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well OASI Number Switzerland

Required Pattern: 
{
  "system" : "urn:oid:2.16.756.5.32"
}
Patient.Slices for identifier.identifier:LocalPid This element is included in summaries. 0..1 Identifier Local patient identifier(s)

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}
Patient.Slices for identifier.identifier:LocalPid.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:LocalPid.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:LocalPid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:LocalPid.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:LocalPid.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:LocalPid.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:LocalPid.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:IDN This element must be supported. This element is included in summaries. 0..1 IdnIdentifier IDN Liechtenstein

Required Pattern: 
{
  "system" : "urn:oid:2.16.438.10.20.10.10.1.2.1"
}
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. C 1..1 CHElmHumanName Whether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)'
Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.Slices for extension.extension:hivcode 1..1 string CH ELM Extension: HIV Code
URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element is included in summaries. 1..1 string masked when using HIV/VCT-extensions or unknown (see IG guidance).
Max Length:100
Patient.name.family.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.family.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.family.Slices for extension.extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
Patient.name.family.Slices for extension.extension:dataabsentreason 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Patient.name.family.Slices for extension.extension:dataabsentreason.id 0..1 string Unique id for inter-element referencing
Patient.name.family.Slices for extension.extension:dataabsentreason.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.name.family.Slices for extension.extension:dataabsentreason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Patient.name.family.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked (extensions allowed)
Patient.name.family.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.given This element is included in summaries. 1..1 string masked when using HIV/VCT-extensions or unknown (see IG guidance).
This repeating element order: Given Names appear in the correct order for presenting the name
Max Length:100
Patient.name.given.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.given.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.given.Slices for extension.extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
Patient.name.given.Slices for extension.extension:dataabsentreason 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Patient.name.given.Slices for extension.extension:dataabsentreason.id 0..1 string Unique id for inter-element referencing
Patient.name.given.Slices for extension.extension:dataabsentreason.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.name.given.Slices for extension.extension:dataabsentreason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Patient.name.given.Slices for extension.extension:dataabsentreason.value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked (extensions allowed)
Patient.name.given.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.prefix This element is included in summaries. 0..* string For 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.
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.prefix.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.prefix.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.name.prefix.Slices for extension.extension:salutationandtitle 0..* code For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
Patient.name.prefix.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown* (* see warning 'ch-pat-2')
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.birthDate.id 0..1 string xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:dataabsentreason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.birthDate.value 0..1 date Primitive value for date
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.Slices for address This element must be supported. This element is included in summaries. 0..1 CHCoreAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the individual
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for address.address:home This element must be supported. This element is included in summaries. 0..1 CHCoreAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Residential address
Patient.Slices for address.address:home.id 0..1 string Unique id for inter-element referencing
Patient.Slices for address.address:home.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.use This element is a modifier element. This element is included in summaries. 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home (extensions allowed)
Patient.Slices for address.address:home.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.Slices for address.address:home.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for address.address:home.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Max Length:50
Patient.Slices for address.address:home.city.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for address.address:home.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.city.Slices for extension Content/Rules for all slices
Patient.Slices for address.address:home.city.Slices for extension.extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
Patient.Slices for address.address:home.city.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for address.address:home.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.Slices for address.address:home.state This element must be supported. This element is included in summaries. 0..1 string sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address.
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
Patient.Slices for address.address:home.postalCode This element must be supported. This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Max Length:10
Patient.Slices for address.address:home.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for address.address:home.country.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for address.address:home.country.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.country.Slices for extension Content/Rules for all slices
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode C 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.id 0..1 string Unique id for inter-element referencing
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
Patient.Slices for address.address:home.country.Slices for extension.extension:countrycode.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.id 0..1 string Unique id for inter-element referencing
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding"
Patient.Slices for address.address:home.country.Slices for extension.extension:country-deprecated.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
Patient.Slices for address.address:home.country.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for address.address:home.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)
Patient.maritalStatus.id 0..1 string Unique id for inter-element referencing
Patient.maritalStatus.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.maritalStatus.Slices for extension.extension:maritalDataSeparation 0..1 CodeableConcept MaritalData Separation
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation
Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type
Patient.maritalStatus.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.maritalStatus.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
Constraints: pat-1
Patient.Slices for contact.contact:All Slices Content/Rules for all slices
Patient.Slices for contact.contact:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:All Slices.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:All Slices.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.Slices for contact.contact:All Slices.name 0..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:All Slices.telecom 0..* ContactPoint A contact detail for the person
Patient.Slices for contact.contact:All Slices.address 0..1 Address Address for the contact person
Patient.Slices for contact.contact:All Slices.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:All Slices.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:All Slices.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.Slices for contact.contact:contact C 0..1 BackboneElement Contact data if it is not the address of the patient
Constraints: pat-1
Patient.Slices for contact.contact:contact.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:contact.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact.relationship 1..1 CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
      "code" : "contactData"
    }
  ]
}
Patient.Slices for contact.contact:contact.name 0..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:contact.address 1..1 CHCoreAddressECH10 The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address for the contact person
Patient.Slices for contact.contact:contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.Slices for contact.contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
Patient.Slices for contact.contact:nameOfParent.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:nameOfParent.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:nameOfParent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:nameOfParent.relationship 1..1 CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "PRN"
    }
  ]
}
Patient.Slices for contact.contact:nameOfParent.name 1..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:nameOfParent.telecom 0..* ContactPoint A contact detail for the person
Patient.Slices for contact.contact:nameOfParent.address 0..1 Address Address for the contact person
Patient.Slices for contact.contact:nameOfParent.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:nameOfParent.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:nameOfParent.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:LocalPid.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name.family.​extension:dataabsentreason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.name.given.extension:dataabsentreason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​state Base example eCH-0007 Canton Abbreviation 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:country-deprecated.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.maritalStatus Base extensible ChCoreMaritalStatus 📦3.3.0 CH Term v3.3
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:contact.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning Patient.address:home.country.extension:countrycode 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'))
ch-core-hm-1 error Patient.name 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 error Patient.name 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 error Patient.name 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 error Patient.name 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()
ch-elm-patient-address-require-countrycode error Patient patient requires country code in address address.country.all(extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-codedString').exists() or extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').exists())
ch-elm-patient-nameorlocalpid error Patient patient requires either name or local pid, but not both identifier.where(type.coding[0].code='MR').exists() implies name.where(given.hasValue() or family.hasValue()).empty()
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2 warning Patient gender 'unknown' is currently not used in Switzerland in eCH and the EPR gender.empty() or gender!='unknown'
ch-pat-3 warning Patient.extension:citizenship 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'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 error Patient 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 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent 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()

This structure is derived from ChElmPatient

Summary

Mandatory: 6 elements
Prohibited: 6 elements

 

Other representations of profile: CSV, Excel, Schematron