CH EKM (R4), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/ch-ekm/ and changes regularly. See the Directory of published versions

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

Resource Profile: CH EKM Patient HIV

Patient representation for HIV

Usages:

• This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	ChEkmPatient	CH EKM Patient HIV Constraints: ch-pat-1, ch-pat-2
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
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
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
extension:citizenship	SC	0..1	(Complex)	Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship Constraints: ch-pat-3
extension:religion		0..1	CodeableConcept	Religion of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:$this
identifier:AHVN13	SΣ	0..1	AHVN13Identifier	OASI Number Switzerland Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:LocalPid	Σ	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)
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..1	CHEkmHumanName	Whether the personal data is transmitted by using initials or full name is described under 'Guidance - Personal Data (Patient Name)'
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:hivcode		1..1	string	CH EKM Extension: HIV Code URL: http://fhir.ch/ig/ch-ekm/StructureDefinition/ch-ekm-ext-hiv-code
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	Σ	1..1	string	Family name (often called 'Surname')
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required)
extension:dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
given	Σ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required)
extension:dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
gender	Σ	1..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
Slices for extension				Content/Rules for all slices
extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SΣ	0..1	CHCoreAddress	An address for the individual Slice: Unordered, Open by value:use
address:home	SΣ	0..1	CHCoreAddress	Residential address
use	?!Σ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
Slices for extension				Content/Rules for all slices
extension:bfs		0..1	string	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
state	SΣ	0..1	string	sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address. Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:countrycode	C	1..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString Constraints: ch-addr-1
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: BFS Verzeichnis der Staaten und Gebiete (required)
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
contact:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
contact:contact	C	0..1	BackboneElement	Contact data if it is not the address of the patient Constraints: pat-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: contactData
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
address		1..1	CHCoreAddressECH10	Address for the contact person
contact:nameOfParent	C	0..*	BackboneElement	Name of parent Constraints: pat-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name		1..1	HumanName	A name associated with the contact person
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:genderIdentity.​extension:value.value[x]	Base	required	Gender Identity	📦2.0.0	THO v7.1
Patient.extension:biologicalSexAtBirth.​extension:value.value[x]	Base	required	CH EKM Biological Sex	📦0.0.1	This IG
Patient.extension:biologicalSexAtBirth.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📦2.0.0	THO v7.1
Patient.extension:biologicalSexAtBirth.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.1
Patient.extension:biologicalSex.​extension:value.value[x]	Base	required	CH EKM Biological Sex	📦0.0.1	This IG
Patient.extension:biologicalSex.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📦2.0.0	THO v7.1
Patient.extension:biologicalSex.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.1
Patient.identifier:LocalPid.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name.family.​extension:dataabsentreason.​value[x]	Base	required	DataAbsentReason	📦4.0.1	FHIR Std.
Patient.name.given.extension:dataabsentreason.​value[x]	Base	required	DataAbsentReason	📦4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:internet.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:internet.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address:home.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​state	Base	example	eCH-0007 Canton Abbreviation	📦3.3.0	CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x]	Base	required	BFS Verzeichnis der Staaten und Gebiete	📦3.3.0	CH Term v3.3
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.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-addr-1	warning	Patient.address:home.country.extension:countrycode	ISO Country Alpha-2 or ISO Country Alpha-3 code	((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-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 ChEkmPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	ChEkmPatient	CH EKM Patient HIV
Slices for extension				Content/Rules for all slices
extension:genderIdentity		0..0		The individual's gender identity
extension:biologicalSexAtBirth		0..0		A recorded sex or gender property for the individual
extension:biologicalSex		0..0		A recorded sex or gender property for the individual
name
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:hivcode		1..1	ChEkmExtHivCode	CH EKM Extension: HIV Code
family
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:dataabsentreason		1..1	DataAbsentReason(5.3.0-ballot-tc1)	unknown | asked | temp | notasked | masked | unsupported | astext | error
value[x]		1..1	code	Value of extension Required Pattern: masked
given
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:dataabsentreason		1..1	DataAbsentReason(5.3.0-ballot-tc1)	unknown | asked | temp | notasked | masked | unsupported | astext | error
value[x]		1..1	code	Value of extension Required Pattern: masked
telecom		0..0		A contact detail for the individual
Slices for telecom				Content/Rules for all slices
telecom:email		0..0		A contact detail for the individual
telecom:phone		0..0		A contact detail for the individual
telecom:internet		0..0		A contact detail for the individual
Slices for address				Content/Rules for all slices
address:home		0..1	CHCoreAddress	Residential address
line		0..0		Street name, number, direction & P.O. Box etc.
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	ChEkmPatient	CH EKM Patient HIV Constraints: ch-pat-1, ch-pat-2
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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
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
extension:citizenship	SC	0..1	(Complex)	Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship Constraints: ch-pat-3
extension:religion		0..1	CodeableConcept	Religion of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:$this
identifier:AHVN13	SΣ	0..1	AHVN13Identifier	OASI Number Switzerland Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:LocalPid	Σ	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)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..1	CHEkmHumanName	Whether the personal data is transmitted by using initials or full name is described under 'Guidance - Personal Data (Patient Name)'
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:hivcode		1..1	string	CH EKM Extension: HIV Code URL: http://fhir.ch/ig/ch-ekm/StructureDefinition/ch-ekm-ext-hiv-code
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required)
extension:dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
value		0..1	string	Primitive value for string Max Length:1048576
given	Σ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required)
extension:dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
value		0..1	string	Primitive value for string Max Length:1048576
prefix	Σ	0..*	string	For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. This repeating element order: Prefixes appear in the correct order for presenting the name
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:salutationandtitle		0..*	code	For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required)
value		0..1	string	Primitive value for string Max Length:1048576
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
gender	Σ	1..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SΣ	0..1	CHCoreAddress	An address for the individual Slice: Unordered, Open by value:use
address:home	SΣ	0..1	CHCoreAddress	Residential address
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bfs		0..1	string	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
value		0..1	string	Primitive value for string Max Length:1048576
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address. Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:countrycode	C	1..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString Constraints: ch-addr-1
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: BFS Verzeichnis der Staaten und Gebiete (required)
value		0..1	string	Primitive value for string Max Length:1048576
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
Slices for contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:relationship Constraints: pat-1
contact:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
contact:contact	C	0..1	BackboneElement	Contact data if it is not the address of the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: contactData
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name		0..1	HumanName	A name associated with the contact person
address		1..1	CHCoreAddressECH10	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
contact:nameOfParent	C	0..*	BackboneElement	Name of parent Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name		1..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
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
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.extension:genderIdentity.​extension:value.value[x]	Base	required	Gender Identity	📦2.0.0	THO v7.1
Patient.extension:biologicalSexAtBirth.​extension:value.value[x]	Base	required	CH EKM Biological Sex	📦0.0.1	This IG
Patient.extension:biologicalSexAtBirth.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📦2.0.0	THO v7.1
Patient.extension:biologicalSexAtBirth.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.1
Patient.extension:biologicalSex.​extension:value.value[x]	Base	required	CH EKM Biological Sex	📦0.0.1	This IG
Patient.extension:biologicalSex.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📦2.0.0	THO v7.1
Patient.extension:biologicalSex.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.1
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.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name.family.​extension:dataabsentreason.​value[x]	Base	required	DataAbsentReason	📦4.0.1	FHIR Std.
Patient.name.given.extension:dataabsentreason.​value[x]	Base	required	DataAbsentReason	📦4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:internet.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:internet.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address:home.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address:home.​type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​state	Base	example	eCH-0007 Canton Abbreviation	📦3.3.0	CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x]	Base	required	BFS Verzeichnis der Staaten und Gebiete	📦3.3.0	CH Term v3.3
Patient.maritalStatus	Base	extensible	ChCoreMaritalStatus	📦3.3.0	CH Term v3.3
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-1	warning	Patient.address:home.country.extension:countrycode	ISO Country Alpha-2 or ISO Country Alpha-3 code	((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-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 ChEkmPatient

Summary

Mandatory: 6 elements
Prohibited: 8 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	ChEkmPatient	CH EKM Patient HIV Constraints: ch-pat-1, ch-pat-2
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
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
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
extension:citizenship	SC	0..1	(Complex)	Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship Constraints: ch-pat-3
extension:religion		0..1	CodeableConcept	Religion of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:$this
identifier:AHVN13	SΣ	0..1	AHVN13Identifier	OASI Number Switzerland Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:LocalPid	Σ	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)
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..1	CHEkmHumanName	Whether the personal data is transmitted by using initials or full name is described under 'Guidance - Personal Data (Patient Name)'
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:hivcode		1..1	string	CH EKM Extension: HIV Code URL: http://fhir.ch/ig/ch-ekm/StructureDefinition/ch-ekm-ext-hiv-code
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	Σ	1..1	string	Family name (often called 'Surname')
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required)
extension:dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
given	Σ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required)
extension:dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
gender	Σ	1..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
Slices for extension				Content/Rules for all slices
extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SΣ	0..1	CHCoreAddress	An address for the individual Slice: Unordered, Open by value:use
address:home	SΣ	0..1	CHCoreAddress	Residential address
use	?!Σ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
Slices for extension				Content/Rules for all slices
extension:bfs		0..1	string	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
state	SΣ	0..1	string	sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address. Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:countrycode	C	1..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString Constraints: ch-addr-1
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: BFS Verzeichnis der Staaten und Gebiete (required)
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
contact:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
contact:contact	C	0..1	BackboneElement	Contact data if it is not the address of the patient Constraints: pat-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: contactData
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
address		1..1	CHCoreAddressECH10	Address for the contact person
contact:nameOfParent	C	0..*	BackboneElement	Name of parent Constraints: pat-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name		1..1	HumanName	A name associated with the contact person
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:genderIdentity.​extension:value.value[x]	Base	required	Gender Identity	📦2.0.0	THO v7.1
Patient.extension:biologicalSexAtBirth.​extension:value.value[x]	Base	required	CH EKM Biological Sex	📦0.0.1	This IG
Patient.extension:biologicalSexAtBirth.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📦2.0.0	THO v7.1
Patient.extension:biologicalSexAtBirth.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.1
Patient.extension:biologicalSex.​extension:value.value[x]	Base	required	CH EKM Biological Sex	📦0.0.1	This IG
Patient.extension:biologicalSex.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📦2.0.0	THO v7.1
Patient.extension:biologicalSex.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.1
Patient.identifier:LocalPid.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name.family.​extension:dataabsentreason.​value[x]	Base	required	DataAbsentReason	📦4.0.1	FHIR Std.
Patient.name.given.extension:dataabsentreason.​value[x]	Base	required	DataAbsentReason	📦4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:internet.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:internet.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address:home.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​state	Base	example	eCH-0007 Canton Abbreviation	📦3.3.0	CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x]	Base	required	BFS Verzeichnis der Staaten und Gebiete	📦3.3.0	CH Term v3.3
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.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-addr-1	warning	Patient.address:home.country.extension:countrycode	ISO Country Alpha-2 or ISO Country Alpha-3 code	((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-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()

Differential View

This structure is derived from ChEkmPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	ChEkmPatient	CH EKM Patient HIV
Slices for extension				Content/Rules for all slices
extension:genderIdentity		0..0		The individual's gender identity
extension:biologicalSexAtBirth		0..0		A recorded sex or gender property for the individual
extension:biologicalSex		0..0		A recorded sex or gender property for the individual
name
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:hivcode		1..1	ChEkmExtHivCode	CH EKM Extension: HIV Code
family
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:dataabsentreason		1..1	DataAbsentReason(5.3.0-ballot-tc1)	unknown | asked | temp | notasked | masked | unsupported | astext | error
value[x]		1..1	code	Value of extension Required Pattern: masked
given
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:dataabsentreason		1..1	DataAbsentReason(5.3.0-ballot-tc1)	unknown | asked | temp | notasked | masked | unsupported | astext | error
value[x]		1..1	code	Value of extension Required Pattern: masked
telecom		0..0		A contact detail for the individual
Slices for telecom				Content/Rules for all slices
telecom:email		0..0		A contact detail for the individual
telecom:phone		0..0		A contact detail for the individual
telecom:internet		0..0		A contact detail for the individual
Slices for address				Content/Rules for all slices
address:home		0..1	CHCoreAddress	Residential address
line		0..0		Street name, number, direction & P.O. Box etc.
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	ChEkmPatient	CH EKM Patient HIV Constraints: ch-pat-1, ch-pat-2
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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
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
extension:citizenship	SC	0..1	(Complex)	Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship Constraints: ch-pat-3
extension:religion		0..1	CodeableConcept	Religion of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:$this
identifier:AHVN13	SΣ	0..1	AHVN13Identifier	OASI Number Switzerland Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:LocalPid	Σ	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)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..1	CHEkmHumanName	Whether the personal data is transmitted by using initials or full name is described under 'Guidance - Personal Data (Patient Name)'
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:hivcode		1..1	string	CH EKM Extension: HIV Code URL: http://fhir.ch/ig/ch-ekm/StructureDefinition/ch-ekm-ext-hiv-code
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required)
extension:dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
value		0..1	string	Primitive value for string Max Length:1048576
given	Σ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required)
extension:dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
value		0..1	string	Primitive value for string Max Length:1048576
prefix	Σ	0..*	string	For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. This repeating element order: Prefixes appear in the correct order for presenting the name
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:salutationandtitle		0..*	code	For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required)
value		0..1	string	Primitive value for string Max Length:1048576
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
gender	Σ	1..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SΣ	0..1	CHCoreAddress	An address for the individual Slice: Unordered, Open by value:use
address:home	SΣ	0..1	CHCoreAddress	Residential address
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bfs		0..1	string	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
value		0..1	string	Primitive value for string Max Length:1048576
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address. Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:countrycode	C	1..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString Constraints: ch-addr-1
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: BFS Verzeichnis der Staaten und Gebiete (required)
value		0..1	string	Primitive value for string Max Length:1048576
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
Slices for contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:relationship Constraints: pat-1
contact:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
contact:contact	C	0..1	BackboneElement	Contact data if it is not the address of the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: contactData
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name		0..1	HumanName	A name associated with the contact person
address		1..1	CHCoreAddressECH10	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
contact:nameOfParent	C	0..*	BackboneElement	Name of parent Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name		1..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
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
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.extension:genderIdentity.​extension:value.value[x]	Base	required	Gender Identity	📦2.0.0	THO v7.1
Patient.extension:biologicalSexAtBirth.​extension:value.value[x]	Base	required	CH EKM Biological Sex	📦0.0.1	This IG
Patient.extension:biologicalSexAtBirth.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📦2.0.0	THO v7.1
Patient.extension:biologicalSexAtBirth.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.1
Patient.extension:biologicalSex.​extension:value.value[x]	Base	required	CH EKM Biological Sex	📦0.0.1	This IG
Patient.extension:biologicalSex.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📦2.0.0	THO v7.1
Patient.extension:biologicalSex.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.1
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.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name.family.​extension:dataabsentreason.​value[x]	Base	required	DataAbsentReason	📦4.0.1	FHIR Std.
Patient.name.given.extension:dataabsentreason.​value[x]	Base	required	DataAbsentReason	📦4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:internet.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:internet.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address:home.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address:home.​type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode	Base	extensible	eCH-010 Address Line Type	📦3.3.0	CH Term v3.3
Patient.address:home.​state	Base	example	eCH-0007 Canton Abbreviation	📦3.3.0	CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x]	Base	required	BFS Verzeichnis der Staaten und Gebiete	📦3.3.0	CH Term v3.3
Patient.maritalStatus	Base	extensible	ChCoreMaritalStatus	📦3.3.0	CH Term v3.3
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-1	warning	Patient.address:home.country.extension:countrycode	ISO Country Alpha-2 or ISO Country Alpha-3 code	((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-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 ChEkmPatient

Summary

Mandatory: 6 elements
Prohibited: 8 elements