CH Core Patient - CH Core (R4) v7.0.0-ballot

CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ballot 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: 7.0.0-ballot	Highlight text changes?
Active as of 2026-10-21		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 personal 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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Description & Constraints Filter:

Patient C 0..* Patient CH Core Patient
Constraints: ch-pat-1, ch-pat-2

Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created

Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Patient.Slices for extension.extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth Place of birth of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth

Patient.Slices for extension.extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin

Patient.Slices for extension.extension:citizenship C 0..* (Complex) Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3

Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)

Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

identifier:EPR-SPID

0..*

EPRSPIDIdentifier

EPR-SPID

Required Pattern:

{
  "system" : "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)

Required Pattern:

{
  "system" : "urn:oid:2.16.756.5.32"
}

identifier:LocalPid

0..*

Identifier

Local patient identifier(s)

Required Pattern:

{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}

Patient.Slices for identifier.identifier:LocalPid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

Patient.Slices for identifier.identifier:LocalPid.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456

identifier:insuranceCardNumber

0..*

VEKAIdentifier

Insurance card number of the patient (20 digits)

Required Pattern:

{
  "system" : "urn:oid:2.16.756.5.30.1.123.100.1.1.1"
}

Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use

Patient.name This element is included in summaries. C 0..* CHCoreHumanName A name associated with the patient
Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4

Patient.Slices for telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Patient.Slices for telecom.telecom:All Slices Content/Rules for all slices

Patient.Slices for telecom.telecom:All Slices.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

Patient.Slices for telecom.telecom:All Slices.value This element is included in summaries. 1..1 string The actual contact point details

Patient.Slices for telecom.telecom:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

Patient.Slices for telecom.telecom:email This element is included in summaries. 0..* CHCoreContactPointECH46Email A contact detail for the individual

Patient.Slices for telecom.telecom:phone This element is included in summaries. 0..* CHCoreContactPointECH46Phone A contact detail for the individual

Patient.Slices for telecom.telecom:internet This element is included in summaries. 0..* CHCoreContactPointECH46Internet A contact detail for the individual

Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown* (* see warning 'ch-pat-2')
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

Patient.birthDate This element is included in summaries. 0..1 date The date of birth for the individual

Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not

Patient.deceased[x].deceasedBoolean boolean

Patient.deceased[x].deceasedDateTime dateTime

Patient.address This element is included in summaries. C 0..* CHCoreAddress An address for the individual
Constraints: ch-addr-2

Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)

Patient.maritalStatus.Slices for extension Content/Rules for all slices

Patient.maritalStatus.Slices for extension.extension:maritalDataSeparation 0..1 CodeableConcept MaritalData Separation
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation
Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type

Patient.Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
Constraints: pat-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Patient.Slices for contact.contact:All Slices Content/Rules for all slices

Patient.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Patient.Slices for contact.contact:contact C 0..1 BackboneElement Contact data if it is not the address of the patient
Constraints: pat-1

Patient.Slices for contact.contact:contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

relationship

1..1

CodeableConcept

The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern:

{
  "coding" : [
    {
      "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
      "code" : "contactData"
    }
  ]
}

Patient.Slices for contact.contact:contact.address C 1..1 CHCoreAddressECH10 Address for the contact person
Constraints: ch-addr-2

Patient.Slices for contact.contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1

Patient.Slices for contact.contact:nameOfParent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

relationship

1..1

CodeableConcept

The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "PRN"
    }
  ]
}

Patient.Slices for contact.contact:nameOfParent.name 1..1 HumanName A name associated with the contact person

Patient.Slices for contact.contact:nameOfParent.gender 0..1 code Sex of the parent (eCH-0021: nameOfParent/sex)
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health

Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

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 Bindings

Purpose

AllLanguages

Max Binding

Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person

Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to

Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:LocalPid.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	ChCoreMaritalStatus	📦3.4.0	CH Term v3.4
Patient.contact:contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact:nameOfParent.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact:nameOfParent.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-addr-2	error	Patient.address, Patient.contact:contact.address	For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.	`country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-codedString' and (value.code = 'CH' or value.code = 'CHE')).empty() or state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')`
ch-core-hm-1	error	Patient.name	if officialName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official	`family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')`
ch-core-hm-2	error	Patient.name	if originalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden	`family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))`
ch-core-hm-3	error	Patient.name	ch-ext-ech-11-name can only be put on a family name	`descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()`
ch-core-hm-4	error	Patient.name	ch-ext-ech-11-firstname can only be put on a given name	`descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()`
ch-pat-1	warning	Patient	If one ore more human names are provided, at least one human name should have a family and a given name.	`name.where(family.exists() and given.exists()).count()>0 or name.empty()`
ch-pat-2	warning	Patient	gender 'unknown' is currently not used in Switzerland in eCH and the EPR	`gender.empty() or gender!='unknown'`
ch-pat-3	warning	Patient.extension:citizenship	ISO Country Alpha-2 or ISO Country Alpha-3 code	`((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))`
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
pat-1	error	Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent	SHALL at least contain a contact's details or a reference to an organization	`name.exists() or telecom.exists() or address.exists() or organization.exists()`

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	CH Core Patient Constraints: ch-pat-1, ch-pat-2
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:placeOfBirth		0..1	CHCoreAddressEch11PlaceOfBirth	Place of birth of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
Patient.Slices for extension.extension:placeOfOrigin		0..*	CHCoreAddressECH11PlaceOfOrigin	Place of origin(s) of the patient URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
Patient.Slices for extension.extension:citizenship	C	0..*	(Complex)	Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship Constraints: ch-pat-3
Patient.Slices for extension.extension:religion		0..1	CodeableConcept	Religion of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (preferred)
Patient.Slices for identifier		0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:EPR-SPID		0..*	EPRSPIDIdentifier	EPR-SPID Required Pattern: `{ "system" : "urn:oid:2.16.756.5.30.1.127.3.10.3" }`
Patient.Slices for identifier.identifier:AHVN13		0..*	AHVN13Identifier	AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points) Required Pattern: `{ "system" : "urn:oid:2.16.756.5.32" }`
Patient.Slices for identifier.identifier:LocalPid		0..*	Identifier	Local patient identifier(s) Required Pattern: `{ "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MR" } ] } }`
Patient.Slices for identifier.identifier:LocalPid.system		1..1	uri	The namespace for the identifier value
Patient.Slices for identifier.identifier:LocalPid.value		1..1	string	The value that is unique
Patient.Slices for identifier.identifier:insuranceCardNumber		0..*	VEKAIdentifier	Insurance card number of the patient (20 digits) Required Pattern: `{ "system" : "urn:oid:2.16.756.5.30.1.123.100.1.1.1" }`
Patient.name		0..*	CHCoreHumanName	A name associated with the patient
Patient.Slices for telecom		0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:All Slices				Content/Rules for all slices
Patient.Slices for telecom.telecom:All Slices.system		1..1	code	phone \| fax \| email \| pager \| url \| sms \| other
Patient.Slices for telecom.telecom:All Slices.value		1..1	string	The actual contact point details
Patient.Slices for telecom.telecom:email		0..*	CHCoreContactPointECH46Email	A contact detail for the individual
Patient.Slices for telecom.telecom:phone		0..*	CHCoreContactPointECH46Phone	A contact detail for the individual
Patient.Slices for telecom.telecom:internet		0..*	CHCoreContactPointECH46Internet	A contact detail for the individual
Patient.gender		0..1	code	male \| female \| other \| unknown* (* see warning 'ch-pat-2')
Patient.birthDate		0..1	date	The date of birth for the individual
Patient.deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not
Patient.address		0..*	CHCoreAddress	An address for the individual
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible)
Patient.maritalStatus.Slices for extension				Content/Rules for all slices
Patient.maritalStatus.Slices for extension.extension:maritalDataSeparation		0..1	CodeableConcept	MaritalData Separation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type
Patient.Slices for contact		0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:relationship Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for contact.contact:contact		0..1	BackboneElement	Contact data if it is not the address of the patient
Patient.Slices for contact.contact:contact.relationship		1..1	CodeableConcept	The kind of relationship Required Pattern: `{ "coding" : [ { "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11", "code" : "contactData" } ] }`
Patient.Slices for contact.contact:contact.telecom		0..0		A contact detail for the person
Patient.Slices for contact.contact:contact.address		1..1	CHCoreAddressECH10	Address for the contact person
Patient.Slices for contact.contact:nameOfParent		0..*	BackboneElement	Name of parent
Patient.Slices for contact.contact:nameOfParent.relationship		1..1	CodeableConcept	The kind of relationship Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code" : "PRN" } ] }`
Patient.Slices for contact.contact:nameOfParent.name		1..1	HumanName	A name associated with the contact person
Patient.Slices for contact.contact:nameOfParent.gender		0..1	code	Sex of the parent (eCH-0021: nameOfParent/sex)
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.maritalStatus	Base	extensible	ChCoreMaritalStatus	📦3.4.0	CH Term v3.4

Constraints

Id	Grade	Path(s)	Description	Expression
ch-pat-1	warning	Patient	If one ore more human names are provided, at least one human name should have a family and a given name.	`name.where(family.exists() and given.exists()).count()>0 or name.empty()`
ch-pat-2	warning	Patient	gender 'unknown' is currently not used in Switzerland in eCH and the EPR	`gender.empty() or gender!='unknown'`
ch-pat-3	warning	Patient.extension:citizenship	ISO Country Alpha-2 or ISO Country Alpha-3 code	`((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))`

Description & Constraints Filter:

Patient C 0..* Patient CH Core Patient
Constraints: ch-pat-1, ch-pat-2

Patient.id This element is included in summaries. 0..1 id Logical id of this artifact

Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource

Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created

language

0..1

code

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

Patient.contained 0..* Resource Contained, inline Resources

Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)

Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

identifier:EPR-SPID

0..*

EPRSPIDIdentifier

EPR-SPID

Required Pattern:

{
  "system" : "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)

Required Pattern:

{
  "system" : "urn:oid:2.16.756.5.32"
}

identifier:LocalPid

0..*

Identifier

Local patient identifier(s)

Required Pattern:

{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}

Patient.Slices for identifier.identifier:LocalPid.id 0..1 string Unique id for inter-element referencing

Patient.Slices for identifier.identifier:LocalPid.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Patient.Slices for identifier.identifier:LocalPid.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456

Patient.Slices for identifier.identifier:LocalPid.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use

Patient.Slices for identifier.identifier:LocalPid.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

identifier:insuranceCardNumber

0..*

VEKAIdentifier

Insurance card number of the patient (20 digits)

Required Pattern:

{
  "system" : "urn:oid:2.16.756.5.30.1.123.100.1.1.1"
}

Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use

Patient.name This element is included in summaries. C 0..* CHCoreHumanName A name associated with the patient
Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4

Patient.Slices for telecom.telecom:All Slices Content/Rules for all slices

Patient.Slices for telecom.telecom:All Slices.id 0..1 string Unique id for inter-element referencing

Patient.Slices for telecom.telecom:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Patient.Slices for telecom.telecom:All Slices.value This element is included in summaries. 1..1 string The actual contact point details

Patient.Slices for telecom.telecom:All Slices.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)

Patient.Slices for telecom.telecom:All Slices.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use

Patient.Slices for telecom.telecom:email This element is included in summaries. 0..* CHCoreContactPointECH46Email A contact detail for the individual

Patient.Slices for telecom.telecom:phone This element is included in summaries. 0..* CHCoreContactPointECH46Phone A contact detail for the individual

Patient.Slices for telecom.telecom:internet This element is included in summaries. 0..* CHCoreContactPointECH46Internet A contact detail for the individual

Patient.birthDate This element is included in summaries. 0..1 date The date of birth for the individual

Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not

Patient.deceased[x].deceasedBoolean boolean

Patient.deceased[x].deceasedDateTime dateTime

Patient.address This element is included in summaries. C 0..* CHCoreAddress An address for the individual
Constraints: ch-addr-2

Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)

Patient.maritalStatus.id 0..1 string Unique id for inter-element referencing

Patient.maritalStatus.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Patient.maritalStatus.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Patient.maritalStatus.text This element is included in summaries. 0..1 string Plain text representation of the concept

Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth

Patient.multipleBirth[x].multipleBirthBoolean boolean

Patient.multipleBirth[x].multipleBirthInteger integer

Patient.photo 0..* Attachment Image of the patient

Patient.Slices for contact.contact:All Slices Content/Rules for all slices

Patient.Slices for contact.contact:All Slices.id 0..1 string Unique id for inter-element referencing

Patient.Slices for contact.contact:All Slices.extension 0..* Extension Additional content defined by implementations

Patient.Slices for contact.contact:All Slices.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Patient.Slices for contact.contact:All Slices.name 0..1 HumanName A name associated with the contact person

Patient.Slices for contact.contact:All Slices.telecom 0..* ContactPoint A contact detail for the person

Patient.Slices for contact.contact:All Slices.address 0..1 Address Address for the contact person

Patient.Slices for contact.contact:All Slices.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

Patient.Slices for contact.contact:All Slices.organization C 0..1 Reference(Organization) Organization that is associated with the contact

Patient.Slices for contact.contact:All Slices.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient

Patient.Slices for contact.contact:contact C 0..1 BackboneElement Contact data if it is not the address of the patient
Constraints: pat-1

Patient.Slices for contact.contact:contact.id 0..1 string Unique id for inter-element referencing

Patient.Slices for contact.contact:contact.extension 0..* Extension Additional content defined by implementations

relationship

1..1

CodeableConcept

The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern:

{
  "coding" : [
    {
      "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
      "code" : "contactData"
    }
  ]
}

Patient.Slices for contact.contact:contact.name 0..1 HumanName A name associated with the contact person

Patient.Slices for contact.contact:contact.address C 1..1 CHCoreAddressECH10 Address for the contact person
Constraints: ch-addr-2

Patient.Slices for contact.contact:contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

Patient.Slices for contact.contact:contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact

Patient.Slices for contact.contact:contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient

Patient.Slices for contact.contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1

Patient.Slices for contact.contact:nameOfParent.id 0..1 string Unique id for inter-element referencing

Patient.Slices for contact.contact:nameOfParent.extension 0..* Extension Additional content defined by implementations

relationship

1..1

CodeableConcept

The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "PRN"
    }
  ]
}

Patient.Slices for contact.contact:nameOfParent.name 1..1 HumanName A name associated with the contact person

Patient.Slices for contact.contact:nameOfParent.telecom 0..* ContactPoint A contact detail for the person

Patient.Slices for contact.contact:nameOfParent.address 0..1 Address Address for the contact person

Patient.Slices for contact.contact:nameOfParent.organization C 0..1 Reference(Organization) Organization that is associated with the contact

Patient.Slices for contact.contact:nameOfParent.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient

Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health

Patient.communication.id 0..1 string Unique id for inter-element referencing

Patient.communication.extension 0..* Extension Additional content defined by implementations

Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

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 Bindings

Purpose

AllLanguages

Max Binding

Patient.communication.preferred 0..1 boolean Language preference indicator

Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider

Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record

Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person

Patient.link.id 0..1 string Unique id for inter-element referencing

Patient.link.extension 0..* Extension Additional content defined by implementations

Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to

Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier:LocalPid.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:LocalPid.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	ChCoreMaritalStatus	📦3.4.0	CH Term v3.4
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.contact:contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact:contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.contact:nameOfParent.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact:nameOfParent.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-addr-2	error	Patient.address, Patient.contact:contact.address	For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.	`country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-codedString' and (value.code = 'CH' or value.code = 'CHE')).empty() or state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')`
ch-core-hm-1	error	Patient.name	if officialName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official	`family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')`
ch-core-hm-2	error	Patient.name	if originalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden	`family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))`
ch-core-hm-3	error	Patient.name	ch-ext-ech-11-name can only be put on a family name	`descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()`
ch-core-hm-4	error	Patient.name	ch-ext-ech-11-firstname can only be put on a given name	`descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()`
ch-pat-1	warning	Patient	If one ore more human names are provided, at least one human name should have a family and a given name.	`name.where(family.exists() and given.exists()).count()>0 or name.empty()`
ch-pat-2	warning	Patient	gender 'unknown' is currently not used in Switzerland in eCH and the EPR	`gender.empty() or gender!='unknown'`
ch-pat-3	warning	Patient.extension:citizenship	ISO Country Alpha-2 or ISO Country Alpha-3 code	`((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))`
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
pat-1	error	Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent	SHALL at least contain a contact's details or a reference to an organization	`name.exists() or telecom.exists() or address.exists() or organization.exists()`

This structure is derived from Patient

Summary

Mandatory: 0 element(8 nested mandatory elements)
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Patient.identifier
The element 1 is sliced based on the value of Patient.telecom
The element 1 is sliced based on the value of Patient.contact

Key Elements View

Description & Constraints Filter:

Patient C 0..* Patient CH Core Patient
Constraints: ch-pat-1, ch-pat-2

Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created

Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)

Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

identifier:EPR-SPID

0..*

EPRSPIDIdentifier

EPR-SPID

Required Pattern:

{
  "system" : "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)

Required Pattern:

{
  "system" : "urn:oid:2.16.756.5.32"
}

identifier:LocalPid

0..*

Identifier

Local patient identifier(s)

Required Pattern:

{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}

Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456

identifier:insuranceCardNumber

0..*

VEKAIdentifier

Insurance card number of the patient (20 digits)

Required Pattern:

{
  "system" : "urn:oid:2.16.756.5.30.1.123.100.1.1.1"
}