CH Core (R4)
6.0.0-ballot-ci-build - ci-build Switzerland flag

CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 6.0.0-ballot-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-core/ and changes regularly. See the Directory of published versions

Resource Profile: CH Core Patient

Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient Version: 6.0.0-ballot-ci-build
Active as of 2025-03-26 Computable Name: CHCorePatient

Copyright/Legal: CC0-1.0

Base definition of the Patient resource for use in Swiss specific use cases. Relevant are definitions by the eCH-0010 V7.0 data standard mailing address and eCH-0011 V8.1 data standard pesond data. The CH Core Patient is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements in Switzerland. See also BFS for further information

Core patient demographics which can be shared

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient CH Core Patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
ch-pat-1: If one ore more human names are provided, at least one human name should have a family and a given name.
ch-pat-2: gender 'unknown' is currently not used in Switzerland in eCH and the EPR
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth Place of birth of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin Place of origin(s) of patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:citizenship C 0..* (Complex) Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
.... extension:religion 0..1 CodeableConcept Religion of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:EPR-SPID Σ 0..* EPRSPIDIdentifier EPR-SPID
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
.... identifier:AHVN13 Σ 0..* AHVN13Identifier AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points)
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
.... identifier:LocalPid Σ 0..* Identifier Local patient identifier(s)
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:insuranceCardNumber Σ 0..* VEKAIdentifier Insurance card number of the patient (20 digits)
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
ele-1: All FHIR elements must have a @value or children
... name Σ 0..* CHCoreHumanName A name associated with the patient
ele-1: All FHIR elements must have a @value or children
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
.... telecom:All Slices Content/Rules for all slices
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... telecom:email Σ 0..* CHCoreContactPointECH46Email A contact detail for the individual
ele-1: All FHIR elements must have a @value or children
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Fixed Value: email
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
...... Slices for extension Content/Rules for all slices
....... extension:emailCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory
Binding: eCH-0046 Email Category (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... telecom:phone Σ 0..* CHCoreContactPointECH46Phone A contact detail for the individual
ele-1: All FHIR elements must have a @value or children
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Fixed Value: phone
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
...... Slices for extension Content/Rules for all slices
....... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... telecom:internet Σ 0..* CHCoreContactPointECH46Internet A contact detail for the individual
ele-1: All FHIR elements must have a @value or children
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Fixed Value: url
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
...... Slices for extension Content/Rules for all slices
....... extension:internetCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-internetcategory
Binding: eCH-0046 Internet Category (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... gender Σ 0..1 code male | female | other | unknown* (* see warning 'ch-pat-2')
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
... birthDate Σ 0..1 date The date of birth for the individual
ele-1: All FHIR elements must have a @value or children
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
ele-1: All FHIR elements must have a @value or children
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* CHCoreAddress An address for the individual
ele-1: All FHIR elements must have a @value or children
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:maritalDataSeparation 0..1 CodeableConcept MaritalData Separation
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation
Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type


ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
ele-1: All FHIR elements must have a @value or children
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... contact:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... contact:contact C 0..1 BackboneElement Contact data if it is not address of patient
ele-1: All FHIR elements must have a @value or children
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... relationship 1..1 CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contactData
..... address 1..1 CHCoreAddressECH10 Address for the contact person
ele-1: All FHIR elements must have a @value or children
.... contact:nameOfParent C 0..* BackboneElement Name of parent
ele-1: All FHIR elements must have a @value or children
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... relationship 1..1 CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
..... name 1..1 HumanName A name associated with the contact person
ele-1: All FHIR elements must have a @value or children
... Slices for communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Slice: Unordered, Open by value:preferred
ele-1: All FHIR elements must have a @value or children
.... communication:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
.... communication:languageOfCorrespondence 0..1 BackboneElement Language of correspondence
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
..... preferred 1..1 boolean Language preference indicator
ele-1: All FHIR elements must have a @value or children
Fixed Value: true
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ele-1: All FHIR elements must have a @value or children
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:LocalPid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.telecom:internet.systemrequiredFixed Value: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom:internet.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleChCoreMaritalStatus
http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.contact:contact.relationshipextensiblePattern: contactData
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:nameOfParent.relationshipextensiblePattern: PRN
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-pat-1warningPatientIf one ore more human names are provided, at least one human name should have a family and a given name.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-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'))
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contact, Patient.contact:contact, Patient.contact:nameOfParentSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

 

Other representations of profile: CSV, Excel, Schematron