CH ELM (R4)
1.0.0-trialuse - trial-use Switzerland flag

This page is part of the Observations of notifiable communicable infectious diseases (v1.0.0-trialuse: STU 1 Draft) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CH ELM Patient

Official URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-patient Version: 1.0.0-trialuse
Draft as of 2023-09-13 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..*ChLabPatientCH ELM Patient
... identifier S0..*IdentifierAn identifier for this patient
... identifier:AHVN13 S0..*AHVN13IdentifierOASI Number Switzerland
... identifier:OASI-LI S0..*OasiLiIdentifierOASI Number Principality of Liechtenstein

Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: http://ahv.li/identifier/oasi
.... text 0..1stringFor usage in the case of HIV/AIDS see IG guidance
.... family 1..1stringIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
.... given 1..*stringIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
... telecom:phone 0..*CHCoreContactPointECH46PhoneCH Core ContactPoint eCH-0046 Phone
.... value 1..1stringThe actual contact point details
Example CH ELM: +41 79 999 55 66
... birthDate C1..1dateThe date of birth for the individual
ch-elm-dateTime: At least the format YYYY-MM-DD is required.
... Slices for address 1..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use
.... address:home 1..1CHCoreAddressResidential address
..... use 1..1codehome | work | temp | old | billing - purpose of this address
Required Pattern: home
..... city S0..1stringName of city, town etc.
..... state S0..1stringSub-unit of country (abbreviations ok)
..... postalCode S0..1stringPostal code for area
..... country
...... extension:countrycode S0..1SC-codingcode 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 C0..*ChLabPatientCH ELM Patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... placeOfBirth 0..1CHCoreAddressEch11PlaceOfBirthPlace 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..*CHCoreAddressECH11PlaceOfOriginPlace of origin(s) of patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
... religion 0..1CodeableConceptReligion of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:EPR-SPID 0..*EPRSPIDIdentifierEPR-SPID

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
.... identifier:AHVN13 S0..*AHVN13IdentifierOASI Number Switzerland

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
.... identifier:LocalPid Σ0..*IdentifierLocal patient identifier(s)

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
.... identifier:insuranceCardNumber 0..*VEKAIdentifierInsurance card number of the patient (20 digits)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
.... identifier:OASI-LI SΣ0..*OasiLiIdentifierOASI Number Principality of Liechtenstein

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://ahv.li/identifier/oasi
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name C1..*CHCoreHumanNameWhether the personal data is transmitted by using initials, full name or a special combination can be seen from the table on p.66 of this document: https://www.bag.admin.ch/dam/bag/de/dokumente/mt/msys/leitfaden-zur-meldepflicht-2023.pdf.download.pdf/meldepflicht-leitfaden-2023-de.pdf
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringFor usage in the case of HIV/AIDS see IG guidance
.... family Σ1..1stringIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
..... ech11name 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (extensible)
.... given Σ1..*stringIn 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
..... ech11firstname 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (extensible)
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email C0..*CHCoreContactPointECH46EmailCH Core ContactPoint eCH-0046 Email
.... telecom:phone C0..*CHCoreContactPointECH46PhoneCH Core ContactPoint eCH-0046 Phone
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

...... phoneCategory 0..1CodeableConceptExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
.... telecom:internet C0..*CHCoreContactPointECH46InternetCH Core ContactPoint eCH-0046 Internet
... birthDate ΣC1..1dateThe date of birth for the individual
ch-elm-dateTime: At least the format YYYY-MM-DD is required.
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... Slices for address 1..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use
.... address:home 1..1CHCoreAddressResidential address
..... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Required Pattern: home
..... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
...... bfs 0..1stringExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
..... state SΣ0..1stringSub-unit of country (abbreviations ok)
..... postalCode SΣ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
...... countrycode SC0..1Codingcode 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.


... Slices for contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
.... contact:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... contact:contact C0..1BackboneElementContact data if it is not address of patient
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: contactData
..... address 1..1CHCoreAddressECH10An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... contact:nameOfFather C0..1BackboneElementName of father
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FTH
..... name 1..1HumanNameA name associated with the contact person
.... contact:nameOfMother C0..1BackboneElementName of mother
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MTH
..... name 1..1HumanNameA name associated with the contact person
... Slices for communication 0..*BackboneElementA 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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... communication:languageOfCorrespondence 0..1BackboneElementLanguage of correspondence
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... preferred 1..1booleanLanguage preference indicator
Fixed Value: true
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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 / Code
Patient.name.userequiredNameUse
Patient.telecom:phone.systemrequiredFixed Value: phone
Patient.telecom:phone.userequiredContactPointUse
Patient.address:home.userequiredPattern: home
Patient.contact:contact.relationshipextensiblePattern: contactData
Patient.contact:nameOfFather.relationshipextensiblePattern: FTH
Patient.contact:nameOfMother.relationshipextensiblePattern: MTH
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

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-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:nameOfFather, Patient.contact:nameOfMotherSHALL 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 C0..*ChLabPatientCH ELM Patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... placeOfBirth 0..1CHCoreAddressEch11PlaceOfBirthPlace 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..*CHCoreAddressECH11PlaceOfOriginPlace of origin(s) of patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
... citizenship C0..*(Complex)Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
... religion 0..1CodeableConceptReligion of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:EPR-SPID 0..*EPRSPIDIdentifierEPR-SPID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:AHVN13 S0..*AHVN13IdentifierOASI Number Switzerland

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:LocalPid Σ0..*IdentifierLocal patient identifier(s)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:insuranceCardNumber 0..*VEKAIdentifierInsurance card number of the patient (20 digits)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:OASI-LI SΣ0..*OasiLiIdentifierOASI Number Principality of Liechtenstein

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://ahv.li/identifier/oasi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name C1..*CHCoreHumanNameWhether the personal data is transmitted by using initials, full name or a special combination can be seen from the table on p.66 of this document: https://www.bag.admin.ch/dam/bag/de/dokumente/mt/msys/leitfaden-zur-meldepflicht-2023.pdf.download.pdf/meldepflicht-leitfaden-2023-de.pdf
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringFor usage in the case of HIV/AIDS see IG guidance
.... family Σ1..1stringIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ech11name 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (extensible)
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... given Σ1..*stringIn 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
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ech11firstname 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (extensible)
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... prefix Σ0..*stringFor 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..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... salutationandtitle 0..*codeFor 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..1stringPrimitive value for string
Max Length: 1048576
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email C0..*CHCoreContactPointECH46EmailCH Core ContactPoint eCH-0046 Email
.... telecom:phone C0..*CHCoreContactPointECH46PhoneCH Core ContactPoint eCH-0046 Phone
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... phoneCategory 0..1CodeableConceptExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
...... value 0..1stringPrimitive value for code
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC0..1dateTimeStarting time with inclusive boundary
...... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
.... telecom:internet C0..*CHCoreContactPointECH46InternetCH Core ContactPoint eCH-0046 Internet
... gender Σ0..1codemale | female | other
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate ΣC1..1dateThe date of birth for the individual
ch-elm-dateTime: At least the format YYYY-MM-DD is required.
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... Slices for address 1..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use
.... address:home 1..1CHCoreAddressResidential address
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Ordered, Open by value:url, value:value
....... addressLine1 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (extensible)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..0
........ url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine1
....... addressLine2 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (extensible)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..0
........ url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine2
....... street 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (extensible)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..0
........ url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: street
....... streetName 0..1stringstreet part of the street line, e.g. withouth housenumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... houseNumber 0..1stringhouseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... unitID 0..1stringunitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
....... postOfficeBoxText 0..1codePostbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (extensible)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..0
........ url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: postOfficeBoxText
....... postOfficeBoxNumber 0..1stringOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... bfs 0..1stringExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state SΣ0..1stringSub-unit of country (abbreviations ok)
..... postalCode SΣ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... countrycode SC0..1Codingcode 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.


...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... maritalDataSeparation 0..1CodeableConceptMaritalData 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..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... Slices for contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
.... contact:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... name 0..1HumanNameA name associated with the contact person
..... telecom 0..*ContactPointA contact detail for the person
..... address 0..1AddressAddress for the contact person
..... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C0..1Reference(Organization)Organization that is associated with the contact
..... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:contact C0..1BackboneElementContact data if it is not address of patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: contactData
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name 0..1HumanNameA name associated with the contact person
..... address 1..1CHCoreAddressECH10An address expressed using postal conventions (as opposed to GPS or other location definition formats)
..... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C0..1Reference(Organization)Organization that is associated with the contact
..... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:nameOfFather C0..1BackboneElementName of father
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FTH
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name 1..1HumanNameA name associated with the contact person
..... telecom 0..*ContactPointA contact detail for the person
..... address 0..1AddressAddress for the contact person
..... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C0..1Reference(Organization)Organization that is associated with the contact
..... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:nameOfMother C0..1BackboneElementName of mother
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MTH
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name 1..1HumanNameA name associated with the contact person
..... telecom 0..*ContactPointA contact detail for the person
..... address 0..1AddressAddress for the contact person
..... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C0..1Reference(Organization)Organization that is associated with the contact
..... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... Slices for communication 0..*BackboneElementA 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... preferred 0..1booleanLanguage preference indicator
.... communication:languageOfCorrespondence 0..1BackboneElementLanguage of correspondence
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... preferred 1..1booleanLanguage preference indicator
Fixed Value: true
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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 / Code
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.name.userequiredNameUse
Patient.telecom:phone.systemrequiredFixed Value: phone
Patient.telecom:phone.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.address:home.userequiredPattern: home
Patient.address:home.typerequiredAddressType
Patient.address:home.line.extension:addressLine1.value[x]:valueCodeextensibleFixed Value: addressLine1
Patient.address:home.line.extension:addressLine2.value[x]:valueCodeextensibleFixed Value: addressLine2
Patient.address:home.line.extension:street.value[x]:valueCodeextensibleFixed Value: street
Patient.address:home.line.extension:postOfficeBoxText.value[x]:valueCodeextensibleFixed Value: postOfficeBoxText
Patient.maritalStatusextensibleChCoreMaritalStatus
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.contact:contact.relationshipextensiblePattern: contactData
Patient.contact:contact.genderrequiredAdministrativeGender
Patient.contact:nameOfFather.relationshipextensiblePattern: FTH
Patient.contact:nameOfFather.genderrequiredAdministrativeGender
Patient.contact:nameOfMother.relationshipextensiblePattern: MTH
Patient.contact:nameOfMother.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

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-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:nameOfFather, Patient.contact:nameOfMotherSHALL 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: 7 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from ChLabPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*ChLabPatientCH ELM Patient
... identifier S0..*IdentifierAn identifier for this patient
... identifier:AHVN13 S0..*AHVN13IdentifierOASI Number Switzerland
... identifier:OASI-LI S0..*OasiLiIdentifierOASI Number Principality of Liechtenstein

Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: http://ahv.li/identifier/oasi
.... text 0..1stringFor usage in the case of HIV/AIDS see IG guidance
.... family 1..1stringIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
.... given 1..*stringIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
... telecom:phone 0..*CHCoreContactPointECH46PhoneCH Core ContactPoint eCH-0046 Phone
.... value 1..1stringThe actual contact point details
Example CH ELM: +41 79 999 55 66
... birthDate C1..1dateThe date of birth for the individual
ch-elm-dateTime: At least the format YYYY-MM-DD is required.
... Slices for address 1..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use
.... address:home 1..1CHCoreAddressResidential address
..... use 1..1codehome | work | temp | old | billing - purpose of this address
Required Pattern: home
..... city S0..1stringName of city, town etc.
..... state S0..1stringSub-unit of country (abbreviations ok)
..... postalCode S0..1stringPostal code for area
..... country
...... extension:countrycode S0..1SC-codingcode 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 C0..*ChLabPatientCH ELM Patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... placeOfBirth 0..1CHCoreAddressEch11PlaceOfBirthPlace 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..*CHCoreAddressECH11PlaceOfOriginPlace of origin(s) of patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
... religion 0..1CodeableConceptReligion of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:EPR-SPID 0..*EPRSPIDIdentifierEPR-SPID

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
.... identifier:AHVN13 S0..*AHVN13IdentifierOASI Number Switzerland

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
.... identifier:LocalPid Σ0..*IdentifierLocal patient identifier(s)

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
.... identifier:insuranceCardNumber 0..*VEKAIdentifierInsurance card number of the patient (20 digits)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
.... identifier:OASI-LI SΣ0..*OasiLiIdentifierOASI Number Principality of Liechtenstein

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://ahv.li/identifier/oasi
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name C1..*CHCoreHumanNameWhether the personal data is transmitted by using initials, full name or a special combination can be seen from the table on p.66 of this document: https://www.bag.admin.ch/dam/bag/de/dokumente/mt/msys/leitfaden-zur-meldepflicht-2023.pdf.download.pdf/meldepflicht-leitfaden-2023-de.pdf
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringFor usage in the case of HIV/AIDS see IG guidance
.... family Σ1..1stringIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
..... ech11name 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (extensible)
.... given Σ1..*stringIn 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
..... ech11firstname 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (extensible)
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email C0..*CHCoreContactPointECH46EmailCH Core ContactPoint eCH-0046 Email
.... telecom:phone C0..*CHCoreContactPointECH46PhoneCH Core ContactPoint eCH-0046 Phone
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

...... phoneCategory 0..1CodeableConceptExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
.... telecom:internet C0..*CHCoreContactPointECH46InternetCH Core ContactPoint eCH-0046 Internet
... birthDate ΣC1..1dateThe date of birth for the individual
ch-elm-dateTime: At least the format YYYY-MM-DD is required.
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... Slices for address 1..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use
.... address:home 1..1CHCoreAddressResidential address
..... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Required Pattern: home
..... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
...... bfs 0..1stringExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
..... state SΣ0..1stringSub-unit of country (abbreviations ok)
..... postalCode SΣ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
...... countrycode SC0..1Codingcode 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.


... Slices for contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
.... contact:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... contact:contact C0..1BackboneElementContact data if it is not address of patient
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: contactData
..... address 1..1CHCoreAddressECH10An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... contact:nameOfFather C0..1BackboneElementName of father
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FTH
..... name 1..1HumanNameA name associated with the contact person
.... contact:nameOfMother C0..1BackboneElementName of mother
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MTH
..... name 1..1HumanNameA name associated with the contact person
... Slices for communication 0..*BackboneElementA 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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... communication:languageOfCorrespondence 0..1BackboneElementLanguage of correspondence
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... preferred 1..1booleanLanguage preference indicator
Fixed Value: true
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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 / Code
Patient.name.userequiredNameUse
Patient.telecom:phone.systemrequiredFixed Value: phone
Patient.telecom:phone.userequiredContactPointUse
Patient.address:home.userequiredPattern: home
Patient.contact:contact.relationshipextensiblePattern: contactData
Patient.contact:nameOfFather.relationshipextensiblePattern: FTH
Patient.contact:nameOfMother.relationshipextensiblePattern: MTH
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

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-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:nameOfFather, Patient.contact:nameOfMotherSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*ChLabPatientCH ELM Patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... placeOfBirth 0..1CHCoreAddressEch11PlaceOfBirthPlace 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..*CHCoreAddressECH11PlaceOfOriginPlace of origin(s) of patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
... citizenship C0..*(Complex)Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
... religion 0..1CodeableConceptReligion of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:EPR-SPID 0..*EPRSPIDIdentifierEPR-SPID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:AHVN13 S0..*AHVN13IdentifierOASI Number Switzerland

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:LocalPid Σ0..*IdentifierLocal patient identifier(s)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:insuranceCardNumber 0..*VEKAIdentifierInsurance card number of the patient (20 digits)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:OASI-LI SΣ0..*OasiLiIdentifierOASI Number Principality of Liechtenstein

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://ahv.li/identifier/oasi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name C1..*CHCoreHumanNameWhether the personal data is transmitted by using initials, full name or a special combination can be seen from the table on p.66 of this document: https://www.bag.admin.ch/dam/bag/de/dokumente/mt/msys/leitfaden-zur-meldepflicht-2023.pdf.download.pdf/meldepflicht-leitfaden-2023-de.pdf
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringFor usage in the case of HIV/AIDS see IG guidance
.... family Σ1..1stringIn the case of HIV/AIDS masked and provide a specific value (see IG guidance)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ech11name 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (extensible)
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... given Σ1..*stringIn 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
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ech11firstname 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (extensible)
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... prefix Σ0..*stringFor 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..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... salutationandtitle 0..*codeFor 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..1stringPrimitive value for string
Max Length: 1048576
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email C0..*CHCoreContactPointECH46EmailCH Core ContactPoint eCH-0046 Email
.... telecom:phone C0..*CHCoreContactPointECH46PhoneCH Core ContactPoint eCH-0046 Phone
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... phoneCategory 0..1CodeableConceptExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
...... value 0..1stringPrimitive value for code
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC0..1dateTimeStarting time with inclusive boundary
...... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
.... telecom:internet C0..*CHCoreContactPointECH46InternetCH Core ContactPoint eCH-0046 Internet
... gender Σ0..1codemale | female | other
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate ΣC1..1dateThe date of birth for the individual
ch-elm-dateTime: At least the format YYYY-MM-DD is required.
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... Slices for address 1..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use
.... address:home 1..1CHCoreAddressResidential address
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Ordered, Open by value:url, value:value
....... addressLine1 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (extensible)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..0
........ url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine1
....... addressLine2 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (extensible)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..0
........ url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine2
....... street 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (extensible)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..0
........ url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: street
....... streetName 0..1stringstreet part of the street line, e.g. withouth housenumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... houseNumber 0..1stringhouseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... unitID 0..1stringunitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
....... postOfficeBoxText 0..1codePostbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (extensible)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..0
........ url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
........ Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: postOfficeBoxText
....... postOfficeBoxNumber 0..1stringOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... bfs 0..1stringExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state SΣ0..1stringSub-unit of country (abbreviations ok)
..... postalCode SΣ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... countrycode SC0..1Codingcode 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.


...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... maritalDataSeparation 0..1CodeableConceptMaritalData 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..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... Slices for contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
.... contact:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... name 0..1HumanNameA name associated with the contact person
..... telecom 0..*ContactPointA contact detail for the person
..... address 0..1AddressAddress for the contact person
..... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C0..1Reference(Organization)Organization that is associated with the contact
..... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:contact C0..1BackboneElementContact data if it is not address of patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: contactData
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name 0..1HumanNameA name associated with the contact person
..... address 1..1CHCoreAddressECH10An address expressed using postal conventions (as opposed to GPS or other location definition formats)
..... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C0..1Reference(Organization)Organization that is associated with the contact
..... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:nameOfFather C0..1BackboneElementName of father
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FTH
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name 1..1HumanNameA name associated with the contact person
..... telecom 0..*ContactPointA contact detail for the person
..... address 0..1AddressAddress for the contact person
..... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C0..1Reference(Organization)Organization that is associated with the contact
..... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:nameOfMother C0..1BackboneElementName of mother
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship 1..1CodeableConceptThe 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MTH
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name 1..1HumanNameA name associated with the contact person
..... telecom 0..*ContactPointA contact detail for the person
..... address 0..1AddressAddress for the contact person
..... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C0..1Reference(Organization)Organization that is associated with the contact
..... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... Slices for communication 0..*BackboneElementA 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... preferred 0..1booleanLanguage preference indicator
.... communication:languageOfCorrespondence 0..1BackboneElementLanguage of correspondence
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... preferred 1..1booleanLanguage preference indicator
Fixed Value: true
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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 / Code
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.name.userequiredNameUse
Patient.telecom:phone.systemrequiredFixed Value: phone
Patient.telecom:phone.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.address:home.userequiredPattern: home
Patient.address:home.typerequiredAddressType
Patient.address:home.line.extension:addressLine1.value[x]:valueCodeextensibleFixed Value: addressLine1
Patient.address:home.line.extension:addressLine2.value[x]:valueCodeextensibleFixed Value: addressLine2
Patient.address:home.line.extension:street.value[x]:valueCodeextensibleFixed Value: street
Patient.address:home.line.extension:postOfficeBoxText.value[x]:valueCodeextensibleFixed Value: postOfficeBoxText
Patient.maritalStatusextensibleChCoreMaritalStatus
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.contact:contact.relationshipextensiblePattern: contactData
Patient.contact:contact.genderrequiredAdministrativeGender
Patient.contact:nameOfFather.relationshipextensiblePattern: FTH
Patient.contact:nameOfFather.genderrequiredAdministrativeGender
Patient.contact:nameOfMother.relationshipextensiblePattern: MTH
Patient.contact:nameOfMother.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

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-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:nameOfFather, Patient.contact:nameOfMotherSHALL 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: 7 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron