CH ELM (R4)
1.3.0 - release Switzerland flag

This page is part of the Observations of notifiable communicable infectious diseases (v1.3.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: CH ELM Patient

Official URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-patient Version: 1.3.0
Active as of 2024-05-17 Computable Name: ChElmPatient

Copyright/Legal: CC0-1.0

This CH ELM base profile constrains the Patient resource for the purpose of laboratory orders and test reports.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ChLabPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* ChLabPatient CH ELM Patient
... identifier S 0..2 Identifier An identifier for this patient
... Slices for identifier Content/Rules for all slices
.... identifier:EPR-SPID 0..0
.... identifier:AHVN13 S 0..1 AHVN13Identifier OASI Number Switzerland
.... identifier:LocalPid 0..0
.... identifier:insuranceCardNumber 0..0
.... identifier:IDN S 0..1 IdnIdentifier IDN Liechtenstein
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.438.10.20.10.10.1.2.1
... name 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)'
.... family 1..1 string In the case of HIV/AIDS masked and provide a specific value (see IG guidance)
Max Length: 100
.... given 1..1 string In the case of HIV/AIDS masked and provide a specific value (see IG guidance)
Max Length: 100
.... telecom:phone 0..1 CHCoreContactPointECH46Phone CH Core ContactPoint eCH-0046 Phone
..... value 1..1 string The actual contact point details
Example CH ELM: +41 79 999 55 66
Max Length: 25
... gender 1..1 code male | female | other
... birthDate C 1..1 date The date of birth for the individual
ch-elm-dateTime: At least the format YYYY-MM-DD is required.
... Slices for address S 0..1 CHCoreAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use
.... address:home S 0..1 CHCoreAddress Residential address
..... use 1..1 code home | work | temp | old | billing - purpose of this address
Required Pattern: home
..... line 0..1 string Street name, number, direction & P.O. Box etc.
...... extension 1..* Extension Extension
...... Slices for extension Content/Rules for all slices
....... extension:streetName 1..1 ADXP-streetName(4.0.1) streetName
........ value[x] 1..1 string Value of extension
Max Length: 100
....... extension:houseNumber S 0..1 ADXP-houseNumber(4.0.1) houseNumber
........ value[x] 1..1 string Value of extension
Max Length: 10
..... city S 0..1 string Name of city, town etc.
Max Length: 50
..... state S 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode S 0..1 string Postal code for area
Max Length: 10
..... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
...... extension 1..* Extension Extension
...... Slices for extension Content/Rules for all slices
....... extension:countrycode 1..1 SC-coding code for string

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-dateTimeerrorPatient.birthDateAt least the format YYYY-MM-DD is required.
: $this.toString().length() >= 10
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* ChLabPatient CH ELM Patient
ch-pat-1: At least one HumanName with given and family name must be provided.
ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR
ch-lab-pat1: The resource should be conform to the corresponding EU LAB profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth Place of birth of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
.... placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin Place of origin(s) of patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
.... citizenship C 0..* (Complex) Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
.... religion 0..1 CodeableConcept Religion of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:AHVN13 S 0..1 AHVN13Identifier OASI Number Switzerland

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
.... identifier:IDN SΣ 0..1 IdnIdentifier IDN Liechtenstein

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.438.10.20.10.10.1.2.1
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name 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)'
ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official
ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden
ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name
ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
.... Slices for extension Content/Rules for all slices
..... vctcode 0..1 string CH ELM Extension: VCT Code
URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-vct-code
..... hivcode 0..1 string CH ELM Extension: HIV Code
URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family Σ 1..1 string In the case of HIV/AIDS masked and provide a specific value (see IG guidance)
Max Length: 100
..... Slices for extension Content/Rules for all slices
...... ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (extensible)
...... dataabsentreason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... given Σ 1..1 string In the case of HIV/AIDS masked and provide a specific value (see IG guidance)
This repeating element order: Given Names appear in the correct order for presenting the name
Max Length: 100
..... Slices for extension Content/Rules for all slices
...... ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (extensible)
...... dataabsentreason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email C 0..* CHCoreContactPointECH46Email CH Core ContactPoint eCH-0046 Email
cpt-2: A system is required if a value is provided.
.... telecom:phone C 0..1 CHCoreContactPointECH46Phone CH Core ContactPoint eCH-0046 Phone
cpt-2: A system is required if a value is provided.
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value Σ 1..1 string The actual contact point details
Example CH ELM: +41 79 999 55 66
Max Length: 25
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... Slices for extension Content/Rules for all slices
....... phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
.... telecom:internet C 0..* CHCoreContactPointECH46Internet CH Core ContactPoint eCH-0046 Internet
cpt-2: A system is required if a value is provided.
... gender Σ 1..1 code male | female | other
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate ΣC 1..1 date The date of birth for the individual
ch-elm-dateTime: At least the format YYYY-MM-DD is required.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SC 0..1 CHCoreAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use
ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
.... address:home SC 0..1 CHCoreAddress Residential address
ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
..... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Required Pattern: home
..... line Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... Slices for extension 1..* Extension Extension
Slice: Ordered, Open by value:url, value:value
....... addressLine1 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
........ extension 0..0
........ url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine1
....... addressLine2 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
........ extension 0..0
........ url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine2
....... street 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
........ extension 0..0
........ url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: street
....... streetName 1..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
........ value[x] 1..1 string Value of extension
Max Length: 100
....... houseNumber S 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
........ value[x] 1..1 string Value of extension
Max Length: 10
....... unitID 0..1 string unitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
....... postOfficeBoxText 0..1 (Complex) Postbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
........ extension 0..0
........ url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: postOfficeBoxText
....... postOfficeBoxNumber 0..1 string Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Max Length: 50
...... Slices for extension Content/Rules for all slices
....... bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address

..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
Max Length: 10
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... countrycode C 1..1 Coding code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.


ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code
... Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... contact:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... contact:contact C 0..1 BackboneElement Contact data if it is not address of patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contactData
..... address C 1..1 CHCoreAddressECH10 An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
.... contact:nameOfParent C 0..* BackboneElement Name of parent
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
..... name 1..1 HumanName A name associated with the contact person
... Slices for communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Slice: Unordered, Open by value:preferred
.... communication:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
.... communication:languageOfCorrespondence 0..1 BackboneElement Language of correspondence
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
..... preferred 1..1 boolean Language preference indicator
Fixed Value: true
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 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

PathConformanceValueSet / CodeURI
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address:home.userequiredPattern: home
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address:home.line.extension:addressLine1.value[x]:valueCodeextensibleFixed Value: addressLine1
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:addressLine2.value[x]:valueCodeextensibleFixed Value: addressLine2
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:street.value[x]:valueCodeextensibleFixed Value: street
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:postOfficeBoxText.value[x]:valueCodeextensibleFixed Value: postOfficeBoxText
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.stateexampleECH007CantonFLAbbreviation
http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation
Patient.contact:contact.relationshipextensiblePattern: contactData
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:nameOfParent.relationshipextensiblePattern: PRN
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-addr-1errorPatient.address:home.country.extension:countrycodeISO 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-addr-2errorPatient.address, Patient.address:home, Patient.contact:contact.addressFor a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
: country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')))
ch-core-hm-1errorPatient.nameif 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-2errorPatient.nameif 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-3errorPatient.namech-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-4errorPatient.namech-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-dateTimeerrorPatient.birthDateAt least the format YYYY-MM-DD is required.
: $this.toString().length() >= 10
ch-lab-pat1warningPatientThe resource should be conform to the corresponding EU LAB profile
: conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Patient-eu-lab')
ch-pat-1errorPatientAt least one HumanName with given and family name must be provided.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2warningPatientgender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ch-pat-3errorPatient.extension:citizenshipISO 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'))
cpt-2errorPatient.telecom:email, Patient.telecom:phone, Patient.telecom:internetA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contact, Patient.contact:contact, Patient.contact:nameOfParentSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* ChLabPatient CH ELM Patient
ch-pat-1: At least one HumanName with given and family name must be provided.
ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR
ch-lab-pat1: The resource should be conform to the corresponding EU LAB profile
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth Place of birth of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
.... placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin Place of origin(s) of patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
.... citizenship C 0..* (Complex) Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
.... religion 0..1 CodeableConcept Religion of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..2 Identifier An identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:AHVN13 S 0..1 AHVN13Identifier OASI Number Switzerland

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:IDN SΣ 0..1 IdnIdentifier IDN Liechtenstein

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.438.10.20.10.10.1.2.1
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name 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)'
ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official
ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden
ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name
ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... vctcode 0..1 string CH ELM Extension: VCT Code
URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-vct-code
..... hivcode 0..1 string CH ELM Extension: HIV Code
URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string In the case of HIV/AIDS masked and provide a specific value (see IG guidance)
Max Length: 100
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (extensible)
...... dataabsentreason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... value 0..1 string Primitive value for string
Max Length: 1048576
.... given Σ 1..1 string In the case of HIV/AIDS masked and provide a specific value (see IG guidance)
This repeating element order: Given Names appear in the correct order for presenting the name
Max Length: 100
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (extensible)
...... dataabsentreason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... value 0..1 string Primitive value for string
Max Length: 1048576
.... prefix Σ 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
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... 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): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.


..... value 0..1 string Primitive value for string
Max Length: 1048576
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email C 0..* CHCoreContactPointECH46Email CH Core ContactPoint eCH-0046 Email
cpt-2: A system is required if a value is provided.
.... telecom:phone C 0..1 CHCoreContactPointECH46Phone CH Core ContactPoint eCH-0046 Phone
cpt-2: A system is required if a value is provided.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value Σ 1..1 string The actual contact point details
Example CH ELM: +41 79 999 55 66
Max Length: 25
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
...... value 0..1 string Primitive value for code
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... telecom:internet C 0..* CHCoreContactPointECH46Internet CH Core ContactPoint eCH-0046 Internet
cpt-2: A system is required if a value is provided.
... gender Σ 1..1 code male | female | other
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate ΣC 1..1 date The date of birth for the individual
ch-elm-dateTime: At least the format YYYY-MM-DD is required.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SC 0..1 CHCoreAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use
ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
.... address:home SC 0..1 CHCoreAddress Residential address
ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Required Pattern: home
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Extension
Slice: Ordered, Open by value:url, value:value
....... addressLine1 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine1
....... addressLine2 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine2
....... street 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: street
....... streetName 1..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
........ value[x] 1..1 string Value of extension
Max Length: 100
....... houseNumber S 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
........ value[x] 1..1 string Value of extension
Max Length: 10
....... unitID 0..1 string unitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
....... postOfficeBoxText 0..1 (Complex) Postbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: postOfficeBoxText
....... postOfficeBoxNumber 0..1 string Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
...... value 0..1 string Primitive value for string
Max Length: 1048576
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Max Length: 50
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
...... value 0..1 string Primitive value for string
Max Length: 1048576
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address

..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
Max Length: 10
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... countrycode C 1..1 Coding code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.


ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code
...... value 0..1 string Primitive value for string
Max Length: 1048576
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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


.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... contact:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


..... name 0..1 HumanName A name associated with the contact person
..... telecom 0..* ContactPoint A contact detail for the person
..... address 0..1 Address Address for the contact person
..... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C 0..1 Reference(Organization) Organization that is associated with the contact
..... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:contact C 0..1 BackboneElement Contact data if it is not address of patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contactData
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... name 0..1 HumanName A name associated with the contact person
..... address C 1..1 CHCoreAddressECH10 An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
..... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C 0..1 Reference(Organization) Organization that is associated with the contact
..... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:nameOfParent C 0..* BackboneElement Name of parent
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... name 1..1 HumanName A name associated with the contact person
..... telecom 0..* ContactPoint A contact detail for the person
..... address 0..1 Address Address for the contact person
..... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C 0..1 Reference(Organization) Organization that is associated with the contact
..... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... Slices for communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Slice: Unordered, Open by value:preferred
.... communication:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
..... preferred 0..1 boolean Language preference indicator
.... communication:languageOfCorrespondence 0..1 BackboneElement Language of correspondence
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
..... preferred 1..1 boolean Language preference indicator
Fixed Value: true
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 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

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address:home.userequiredPattern: home
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address:home.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address:home.line.extension:addressLine1.value[x]:valueCodeextensibleFixed Value: addressLine1
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:addressLine2.value[x]:valueCodeextensibleFixed Value: addressLine2
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:street.value[x]:valueCodeextensibleFixed Value: street
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:postOfficeBoxText.value[x]:valueCodeextensibleFixed Value: postOfficeBoxText
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.stateexampleECH007CantonFLAbbreviation
http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation
Patient.maritalStatusextensibleChCoreMaritalStatus
http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.contact:contact.relationshipextensiblePattern: contactData
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.contact:nameOfParent.relationshipextensiblePattern: PRN
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:nameOfParent.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-addr-1errorPatient.address:home.country.extension:countrycodeISO 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-addr-2errorPatient.address, Patient.address:home, Patient.contact:contact.addressFor a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
: country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')))
ch-core-hm-1errorPatient.nameif 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-2errorPatient.nameif 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-3errorPatient.namech-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-4errorPatient.namech-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-dateTimeerrorPatient.birthDateAt least the format YYYY-MM-DD is required.
: $this.toString().length() >= 10
ch-lab-pat1warningPatientThe resource should be conform to the corresponding EU LAB profile
: conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Patient-eu-lab')
ch-pat-1errorPatientAt least one HumanName with given and family name must be provided.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2warningPatientgender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ch-pat-3errorPatient.extension:citizenshipISO 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'))
cpt-2errorPatient.telecom:email, Patient.telecom:phone, Patient.telecom:internetA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contact, Patient.contact:contact, Patient.contact:nameOfParentSHALL 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 ChLabPatient

Summary

Mandatory: 5 elements(5 nested mandatory elements)
Must-Support: 10 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.address

Differential View

This structure is derived from ChLabPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* ChLabPatient CH ELM Patient
... identifier S 0..2 Identifier An identifier for this patient
... Slices for identifier Content/Rules for all slices
.... identifier:EPR-SPID 0..0
.... identifier:AHVN13 S 0..1 AHVN13Identifier OASI Number Switzerland
.... identifier:LocalPid 0..0
.... identifier:insuranceCardNumber 0..0
.... identifier:IDN S 0..1 IdnIdentifier IDN Liechtenstein
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.438.10.20.10.10.1.2.1
... name 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)'
.... family 1..1 string In the case of HIV/AIDS masked and provide a specific value (see IG guidance)
Max Length: 100
.... given 1..1 string In the case of HIV/AIDS masked and provide a specific value (see IG guidance)
Max Length: 100
.... telecom:phone 0..1 CHCoreContactPointECH46Phone CH Core ContactPoint eCH-0046 Phone
..... value 1..1 string The actual contact point details
Example CH ELM: +41 79 999 55 66
Max Length: 25
... gender 1..1 code male | female | other
... birthDate C 1..1 date The date of birth for the individual
ch-elm-dateTime: At least the format YYYY-MM-DD is required.
... Slices for address S 0..1 CHCoreAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use
.... address:home S 0..1 CHCoreAddress Residential address
..... use 1..1 code home | work | temp | old | billing - purpose of this address
Required Pattern: home
..... line 0..1 string Street name, number, direction & P.O. Box etc.
...... extension 1..* Extension Extension
...... Slices for extension Content/Rules for all slices
....... extension:streetName 1..1 ADXP-streetName(4.0.1) streetName
........ value[x] 1..1 string Value of extension
Max Length: 100
....... extension:houseNumber S 0..1 ADXP-houseNumber(4.0.1) houseNumber
........ value[x] 1..1 string Value of extension
Max Length: 10
..... city S 0..1 string Name of city, town etc.
Max Length: 50
..... state S 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode S 0..1 string Postal code for area
Max Length: 10
..... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
...... extension 1..* Extension Extension
...... Slices for extension Content/Rules for all slices
....... extension:countrycode 1..1 SC-coding code for string

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-dateTimeerrorPatient.birthDateAt least the format YYYY-MM-DD is required.
: $this.toString().length() >= 10

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* ChLabPatient CH ELM Patient
ch-pat-1: At least one HumanName with given and family name must be provided.
ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR
ch-lab-pat1: The resource should be conform to the corresponding EU LAB profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth Place of birth of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
.... placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin Place of origin(s) of patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
.... citizenship C 0..* (Complex) Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
.... religion 0..1 CodeableConcept Religion of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:AHVN13 S 0..1 AHVN13Identifier OASI Number Switzerland

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
.... identifier:IDN SΣ 0..1 IdnIdentifier IDN Liechtenstein

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.438.10.20.10.10.1.2.1
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name 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)'
ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official
ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden
ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name
ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
.... Slices for extension Content/Rules for all slices