This page is part of the Observations of notifiable communicable infectious diseases (v1.6.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: CH ELM Patient HIV

Patient representation for HIV

Usage:

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

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 ChElmPatient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	ChElmPatient	CH ELM Patient HIV This profile also imposes the profile Patient: Person
name
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:vctcode		0..0
extension:hivcode		1..1	ChElmExtHivCode	CH ELM Extension: HIV Code
family
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:dataabsentreason		1..1	DataAbsentReason(5.1.0)	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.1.0)	unknown | asked | temp | notasked | masked | unsupported | astext | error
value[x]		1..1	code	Value of extension Required Pattern: masked
telecom		0..0
Slices for telecom				Content/Rules for all slices
telecom:email		0..0
telecom:phone		0..0
telecom:internet		0..0
Slices for address				Content/Rules for all slices
address:home		0..1	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
line		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	ChElmPatient	CH ELM Patient HIV This profile also imposes the profile Patient: Person ch-pat-1: At least one HumanName with given and family name must be provided. 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
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
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
religion		0..1	CodeableConcept	Religion of 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..1	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:$this
identifier:AHVN13	S	0..1	AHVN13Identifier	OASI Number Switzerland 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:IDN	SΣ	0..1	IdnIdentifier	IDN Liechtenstein Required Pattern: At least the following
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.438.10.20.10.10.1.2.1
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	C	1..1	CHElmHumanName	Whether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)' 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 extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hivcode		1..1	string	CH ELM Extension: HIV Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-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	masked when using HIV/VCT-extensions (see IG guidance). Max Length: 100
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible)
dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
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	masked when using HIV/VCT-extensions (see IG guidance). This repeating element order: Given Names appear in the correct order for presenting the name Max Length: 100
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible)
dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
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	male | female | other Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	ΣC	1..1	date	The date of birth for the individual ch-elm-dateTime: At least the format YYYY-MM-DD is required.
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SC	0..1	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) Slice: Unordered, Open by value:use ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
address:home	SC	0..1	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.
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 Max Length: 50
Slices for extension				Content/Rules for all slices
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 incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132 Max Length: 10
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
countrycode	C	1..1	Coding	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding Description (No ValueSet): (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code
Slices for contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:relationship pat-1: SHALL at least contain a contact's details or a reference to an organization
contact:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
contact:contact	C	0..1	BackboneElement	Contact data if it is not address of patient pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
code		1..1	code	Symbol in syntax defined by the system Fixed Value: contactData
address	C	1..1	CHCoreAddressECH10	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.
contact:nameOfParent	C	0..*	BackboneElement	Name of parent pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
name		1..1	HumanName	A name associated with the contact person
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
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
communication:languageOfCorrespondence		0..1	BackboneElement	Language of correspondence
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
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	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.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name.family.extension:dataabsentreason.value[x]	required	Pattern: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.name.given.extension:dataabsentreason.value[x]	required	Pattern: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.telecom:phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom:phone.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.address:home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address:home.line.extension:addressLine1.value[x]:valueCode	extensible	Fixed Value: addressLine1 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:addressLine2.value[x]:valueCode	extensible	Fixed Value: addressLine2 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:street.value[x]:valueCode	extensible	Fixed Value: street http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:postOfficeBoxText.value[x]:valueCode	extensible	Fixed Value: postOfficeBoxText http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.state	example	ECH007CantonFLAbbreviation http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.communication:languageOfCorrespondence.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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-1	error	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-addr-2	error	Patient.address, Patient.address:home, 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	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	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	ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()
ch-core-hm-4	error	Patient.name	ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()
ch-elm-dateTime	error	Patient.birthDate	At least the format YYYY-MM-DD is required. : $this.toString().length() >= 10
ch-pat-1	error	Patient	At least one HumanName with given and family name must be provided. : name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-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'))
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()

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	ChElmPatient	CH ELM Patient HIV This profile also imposes the profile Patient: Person ch-pat-1: At least one HumanName with given and family name must be provided. 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
religion		0..1	CodeableConcept	Religion of 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..1	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:$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:IDN	SΣ	0..1	IdnIdentifier	IDN Liechtenstein 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.438.10.20.10.10.1.2.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
name	C	1..1	CHElmHumanName	Whether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)' 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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hivcode		1..1	string	CH ELM Extension: HIV Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-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	masked when using HIV/VCT-extensions (see IG guidance). Max Length: 100
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible)
dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
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	masked when using HIV/VCT-extensions (see IG guidance). This repeating element order: Given Names appear in the correct order for presenting the name Max Length: 100
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible)
dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
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
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	male | female | other Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	ΣC	1..1	date	The date of birth for the individual ch-elm-dateTime: At least the format YYYY-MM-DD is required.
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SC	0..1	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) Slice: Unordered, Open by value:use ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
address:home	SC	0..1	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.
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 Max Length: 50
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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 incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132 Max Length: 10
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
countrycode	C	1..1	Coding	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding Description (No ValueSet): (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code
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
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 pat-1: SHALL at least contain a contact's details or a reference to an organization
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 address of patient pat-1: SHALL at least contain a contact's details or a reference to an organization
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	C	1..1	CHCoreAddressECH10	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.
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 pat-1: SHALL at least contain a contact's details or a reference to an organization
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
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	Σ	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	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name.family.extension:dataabsentreason.value[x]	required	Pattern: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.name.given.extension:dataabsentreason.value[x]	required	Pattern: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.telecom:phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom:phone.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.address:home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address:home.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address:home.line.extension:addressLine1.value[x]:valueCode	extensible	Fixed Value: addressLine1 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:addressLine2.value[x]:valueCode	extensible	Fixed Value: addressLine2 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:street.value[x]:valueCode	extensible	Fixed Value: street http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:postOfficeBoxText.value[x]:valueCode	extensible	Fixed Value: postOfficeBoxText http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.state	example	ECH007CantonFLAbbreviation http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.communication:languageOfCorrespondence.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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-1	error	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-addr-2	error	Patient.address, Patient.address:home, 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	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	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	ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()
ch-core-hm-4	error	Patient.name	ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()
ch-elm-dateTime	error	Patient.birthDate	At least the format YYYY-MM-DD is required. : $this.toString().length() >= 10
ch-pat-1	error	Patient	At least one HumanName with given and family name must be provided. : name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-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'))
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 ChElmPatient

Summary

Mandatory: 6 elements
Prohibited: 6 elements

Differential View

This structure is derived from ChElmPatient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	ChElmPatient	CH ELM Patient HIV This profile also imposes the profile Patient: Person
name
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:vctcode		0..0
extension:hivcode		1..1	ChElmExtHivCode	CH ELM Extension: HIV Code
family
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:dataabsentreason		1..1	DataAbsentReason(5.1.0)	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.1.0)	unknown | asked | temp | notasked | masked | unsupported | astext | error
value[x]		1..1	code	Value of extension Required Pattern: masked
telecom		0..0
Slices for telecom				Content/Rules for all slices
telecom:email		0..0
telecom:phone		0..0
telecom:internet		0..0
Slices for address				Content/Rules for all slices
address:home		0..1	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
line		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	ChElmPatient	CH ELM Patient HIV This profile also imposes the profile Patient: Person ch-pat-1: At least one HumanName with given and family name must be provided. 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
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
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
religion		0..1	CodeableConcept	Religion of 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..1	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:$this
identifier:AHVN13	S	0..1	AHVN13Identifier	OASI Number Switzerland 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:IDN	SΣ	0..1	IdnIdentifier	IDN Liechtenstein Required Pattern: At least the following
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.438.10.20.10.10.1.2.1
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	C	1..1	CHElmHumanName	Whether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)' 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 extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hivcode		1..1	string	CH ELM Extension: HIV Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-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	masked when using HIV/VCT-extensions (see IG guidance). Max Length: 100
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible)
dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
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	masked when using HIV/VCT-extensions (see IG guidance). This repeating element order: Given Names appear in the correct order for presenting the name Max Length: 100
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible)
dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
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	male | female | other Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	ΣC	1..1	date	The date of birth for the individual ch-elm-dateTime: At least the format YYYY-MM-DD is required.
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SC	0..1	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) Slice: Unordered, Open by value:use ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
address:home	SC	0..1	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.
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 Max Length: 50
Slices for extension				Content/Rules for all slices
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 incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132 Max Length: 10
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
countrycode	C	1..1	Coding	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding Description (No ValueSet): (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code
Slices for contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:relationship pat-1: SHALL at least contain a contact's details or a reference to an organization
contact:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
contact:contact	C	0..1	BackboneElement	Contact data if it is not address of patient pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
code		1..1	code	Symbol in syntax defined by the system Fixed Value: contactData
address	C	1..1	CHCoreAddressECH10	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.
contact:nameOfParent	C	0..*	BackboneElement	Name of parent pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
name		1..1	HumanName	A name associated with the contact person
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
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
communication:languageOfCorrespondence		0..1	BackboneElement	Language of correspondence
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
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	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.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name.family.extension:dataabsentreason.value[x]	required	Pattern: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.name.given.extension:dataabsentreason.value[x]	required	Pattern: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.telecom:phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom:phone.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.address:home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address:home.line.extension:addressLine1.value[x]:valueCode	extensible	Fixed Value: addressLine1 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:addressLine2.value[x]:valueCode	extensible	Fixed Value: addressLine2 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:street.value[x]:valueCode	extensible	Fixed Value: street http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:postOfficeBoxText.value[x]:valueCode	extensible	Fixed Value: postOfficeBoxText http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.state	example	ECH007CantonFLAbbreviation http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.communication:languageOfCorrespondence.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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-1	error	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-addr-2	error	Patient.address, Patient.address:home, 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	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	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	ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()
ch-core-hm-4	error	Patient.name	ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()
ch-elm-dateTime	error	Patient.birthDate	At least the format YYYY-MM-DD is required. : $this.toString().length() >= 10
ch-pat-1	error	Patient	At least one HumanName with given and family name must be provided. : name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-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'))
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	ChElmPatient	CH ELM Patient HIV This profile also imposes the profile Patient: Person ch-pat-1: At least one HumanName with given and family name must be provided. 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
religion		0..1	CodeableConcept	Religion of 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..1	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:$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:IDN	SΣ	0..1	IdnIdentifier	IDN Liechtenstein 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.438.10.20.10.10.1.2.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
name	C	1..1	CHElmHumanName	Whether the personal data is transmitted by using initials, full name or a special combination is described under 'Guidance - Personal Data (Patient Name)' 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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hivcode		1..1	string	CH ELM Extension: HIV Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-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	masked when using HIV/VCT-extensions (see IG guidance). Max Length: 100
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible)
dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
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	masked when using HIV/VCT-extensions (see IG guidance). This repeating element order: Given Names appear in the correct order for presenting the name Max Length: 100
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible)
dataabsentreason		1..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
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
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	male | female | other Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	ΣC	1..1	date	The date of birth for the individual ch-elm-dateTime: At least the format YYYY-MM-DD is required.
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SC	0..1	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) Slice: Unordered, Open by value:use ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
address:home	SC	0..1	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.
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 Max Length: 50
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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 incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132 Max Length: 10
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
countrycode	C	1..1	Coding	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding Description (No ValueSet): (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code
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
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 pat-1: SHALL at least contain a contact's details or a reference to an organization
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 address of patient pat-1: SHALL at least contain a contact's details or a reference to an organization
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	C	1..1	CHCoreAddressECH10	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.
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 pat-1: SHALL at least contain a contact's details or a reference to an organization
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
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	Σ	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	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name.family.extension:dataabsentreason.value[x]	required	Pattern: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.name.given.extension:dataabsentreason.value[x]	required	Pattern: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.telecom:phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom:phone.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.address:home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address:home.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address:home.line.extension:addressLine1.value[x]:valueCode	extensible	Fixed Value: addressLine1 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:addressLine2.value[x]:valueCode	extensible	Fixed Value: addressLine2 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:street.value[x]:valueCode	extensible	Fixed Value: street http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.line.extension:postOfficeBoxText.value[x]:valueCode	extensible	Fixed Value: postOfficeBoxText http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address:home.state	example	ECH007CantonFLAbbreviation http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.communication:languageOfCorrespondence.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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-1	error	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-addr-2	error	Patient.address, Patient.address:home, 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	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	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	ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()
ch-core-hm-4	error	Patient.name	ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()
ch-elm-dateTime	error	Patient.birthDate	At least the format YYYY-MM-DD is required. : $this.toString().length() >= 10
ch-pat-1	error	Patient	At least one HumanName with given and family name must be provided. : name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-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'))
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 ChElmPatient

Summary

Mandatory: 6 elements
Prohibited: 6 elements