This page is part of the CH EPR FHIR (R4) (v4.0.1: DSTU 4) based on FHIR (HL7® FHIR® Standard) 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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: CH PIXm Patient Feed

The patient demographics and identifier information which can be provided in the PIXm Feed according to the EPR. The EPR-SPID as an identifier SHALL be added. The birthname can be added with the ISO 21090 qualifier extension.

Usage:

• Examples for this Resource Profile: Patient/PatientPIXmFeed

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from CHPDQmPatient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	CHPDQmPatient	CH Core Patient
identifier		2..*	Identifier	An identifier for this patient
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	CHPDQmPatient	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				Content/Rules for all slices
placeOfBirth		0..1	CHCoreAddressEch11PlaceOfBirth	Place of birth of patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
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
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
Slices for identifier	SΣ	2..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children
identifier:EPR-SPID	S	1..1	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	SΣ	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
Slices for name	SC	1..*	CHCoreHumanName	Name of a human - parts and usage Slice: Unordered, Open by profile:$this ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
name:HumanName	SC	1..*	ChEprFhirHumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName'
name:BirthName	SC	0..1	ChEprFhirBirthName	The birthname of the patient ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
Slices for 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	C	0..*	CHCoreContactPointECH46Email	CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children
telecom:phone	C	0..*	CHCoreContactPointECH46Phone	CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children
telecom:internet	C	0..*	CHCoreContactPointECH46Internet	CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided. 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
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 Bindings Purpose 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 Bindings Purpose 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
managingOrganization	SΣ	0..1	Reference(CH PDQm Provider Organization)	Provider organization of the patient ele-1: All FHIR elements must have a @value or children
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:LocalPid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.contact:contact.relationship	extensible	Pattern: contactData http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact:nameOfParent.relationship	extensible	Pattern: PRN http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-addr-2	error	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-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')))
ch-core-hm-1	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	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, Patient.name:HumanName, Patient.name:BirthName	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-epr-fhir-1	error	Patient.name:HumanName	For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false
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	error	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'))
cpt-2	error	Patient.telecom:email, Patient.telecom:phone, Patient.telecom:internet	A system is required if a value is provided. : value.empty() or system.exists()
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()

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	CHPDQmPatient	CH Core Patient 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
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
placeOfBirth		0..1	CHCoreAddressEch11PlaceOfBirth	Place of birth of patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
placeOfOrigin		0..*	CHCoreAddressECH11PlaceOfOrigin	Place of origin(s) of patient URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
citizenship	C	0..*	(Complex)	Citizenship(s) of patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	2..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:$this
identifier:EPR-SPID	S	1..1	EPRSPIDIdentifier	EPR-SPID Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:AHVN13		0..*	AHVN13Identifier	AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:LocalPid	SΣ	0..*	Identifier	Local patient identifier(s) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		1..1	CodeableConcept	Description of identifier Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system		0..1	uri	The namespace for the identifier value
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	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.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:insuranceCardNumber		0..*	VEKAIdentifier	Insurance card number of the patient (20 digits) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
Slices for name	SC	1..*	CHCoreHumanName	Name of a human - parts and usage Slice: Unordered, Open by profile:$this ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
name:HumanName	SC	1..*	ChEprFhirHumanName	A name associated with the patient ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName'
name:BirthName	SC	0..1	ChEprFhirBirthName	The birthname of the patient ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
Slices for telecom	Σ	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:email	C	0..*	CHCoreContactPointECH46Email	CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided.
telecom:phone	C	0..*	CHCoreContactPointECH46Phone	CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided.
telecom:internet	C	0..*	CHCoreContactPointECH46Internet	CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided.
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.
birthDate	Σ	0..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	C	0..*	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
maritalDataSeparation		0..1	CodeableConcept	MaritalData Separation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
Slices for communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Slice: Unordered, Open by value:preferred
communication:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
communication:languageOfCorrespondence		0..1	BackboneElement	Language of correspondence
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		1..1	boolean	Language preference indicator Fixed Value: true
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	SΣ	0..1	Reference(CH PDQm Provider Organization)	Provider organization of the patient
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier:LocalPid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:LocalPid.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	ChCoreMaritalStatus http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.contact:contact.relationship	extensible	Pattern: contactData http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact:contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.contact:nameOfParent.relationship	extensible	Pattern: PRN http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact:nameOfParent.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')))
ch-core-hm-1	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	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, Patient.name:HumanName, Patient.name:BirthName	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-epr-fhir-1	error	Patient.name:HumanName	For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false
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	error	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'))
cpt-2	error	Patient.telecom:email, Patient.telecom:phone, Patient.telecom:internet	A system is required if a value is provided. : value.empty() or system.exists()
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()

This structure is derived from CHPDQmPatient

Summary

Differential View

This structure is derived from CHPDQmPatient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	CHPDQmPatient	CH Core Patient
identifier		2..*	Identifier	An identifier for this patient
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	CHPDQmPatient	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				Content/Rules for all slices
placeOfBirth		0..1	CHCoreAddressEch11PlaceOfBirth	Place of birth of patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
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
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
Slices for identifier	SΣ	2..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children
identifier:EPR-SPID	S	1..1	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	SΣ	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
Slices for name	SC	1..*	CHCoreHumanName	Name of a human - parts and usage Slice: Unordered, Open by profile:$this ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
name:HumanName	SC	1..*	ChEprFhirHumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName'
name:BirthName	SC	0..1	ChEprFhirBirthName	The birthname of the patient ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
Slices for 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	C	0..*	CHCoreContactPointECH46Email	CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children
telecom:phone	C	0..*	CHCoreContactPointECH46Phone	CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children
telecom:internet	C	0..*	CHCoreContactPointECH46Internet	CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided. 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
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 Bindings Purpose 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 Bindings Purpose 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
managingOrganization	SΣ	0..1	Reference(CH PDQm Provider Organization)	Provider organization of the patient ele-1: All FHIR elements must have a @value or children
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:LocalPid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.contact:contact.relationship	extensible	Pattern: contactData http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact:nameOfParent.relationship	extensible	Pattern: PRN http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-addr-2	error	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-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')))
ch-core-hm-1	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	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, Patient.name:HumanName, Patient.name:BirthName	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-epr-fhir-1	error	Patient.name:HumanName	For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false
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	error	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'))
cpt-2	error	Patient.telecom:email, Patient.telecom:phone, Patient.telecom:internet	A system is required if a value is provided. : value.empty() or system.exists()
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	CHPDQmPatient	CH Core Patient 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
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
placeOfBirth		0..1	CHCoreAddressEch11PlaceOfBirth	Place of birth of patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
placeOfOrigin		0..*	CHCoreAddressECH11PlaceOfOrigin	Place of origin(s) of patient URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
citizenship	C	0..*	(Complex)	Citizenship(s) of patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	2..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:$this
identifier:EPR-SPID	S	1..1	EPRSPIDIdentifier	EPR-SPID Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:AHVN13		0..*	AHVN13Identifier	AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:LocalPid	SΣ	0..*	Identifier	Local patient identifier(s) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		1..1	CodeableConcept	Description of identifier Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system		0..1	uri	The namespace for the identifier value
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	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.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:insuranceCardNumber		0..*	VEKAIdentifier	Insurance card number of the patient (20 digits) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
Slices for name	SC	1..*	CHCoreHumanName	Name of a human - parts and usage Slice: Unordered, Open by profile:$this ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
name:HumanName	SC	1..*	ChEprFhirHumanName	A name associated with the patient ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName'
name:BirthName	SC	0..1	ChEprFhirBirthName	The birthname of the patient ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
Slices for telecom	Σ	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:email	C	0..*	CHCoreContactPointECH46Email	CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided.
telecom:phone	C	0..*	CHCoreContactPointECH46Phone	CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided.
telecom:internet	C	0..*	CHCoreContactPointECH46Internet	CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided.
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.
birthDate	Σ	0..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	C	0..*	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
maritalDataSeparation		0..1	CodeableConcept	MaritalData Separation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
Slices for communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Slice: Unordered, Open by value:preferred
communication:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
communication:languageOfCorrespondence		0..1	BackboneElement	Language of correspondence
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		1..1	boolean	Language preference indicator Fixed Value: true
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	SΣ	0..1	Reference(CH PDQm Provider Organization)	Provider organization of the patient
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier:LocalPid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:LocalPid.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	ChCoreMaritalStatus http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.contact:contact.relationship	extensible	Pattern: contactData http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact:contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.contact:nameOfParent.relationship	extensible	Pattern: PRN http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact:nameOfParent.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')))
ch-core-hm-1	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	Patient.name, Patient.name:HumanName, Patient.name:BirthName	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, Patient.name:HumanName, Patient.name:BirthName	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-epr-fhir-1	error	Patient.name:HumanName	For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false
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	error	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'))
cpt-2	error	Patient.telecom:email, Patient.telecom:phone, Patient.telecom:internet	A system is required if a value is provided. : value.empty() or system.exists()
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()

This structure is derived from CHPDQmPatient

Summary

Other representations of profile: CSV, Excel, Schematron