This page is part of the CH Core (R4) (v1.0.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.0.0-ballot. For a full list of available versions, see the Directory of published versions

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

StructureDefinition: CHCoreCompositionPatientEPR

Core patient definition in the context of the electronic patient record (EPR). It is used to include the patient in an EPR document (referenced in Composition/DocumentReference).

The official URL for this profile is:

http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-composition-patient-epr

Formal Views of Profile Content

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

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.language	preferred	CommonLanguages Max Binding: AllLanguages
Patient.identifier:EPR-SPID.use	required	IdentifierUse
Patient.identifier:EPR-SPID.type	extensible	Identifier Type Codes
Patient.identifier:AHVN13.use	required	IdentifierUse
Patient.identifier:AHVN13.type	extensible	Identifier Type Codes
Patient.identifier:LocalPid.use	required	IdentifierUse
Patient.identifier:LocalPid.type	extensible	Identifier Type Codes
Patient.gender	required	AdministrativeGender
Patient.maritalStatus	required	ChCoreMaritalStatus
Patient.contact.relationship	extensible	PatientContactRelationship
Patient.contact.gender	required	AdministrativeGender
Patient.contact:contact.relationship	extensible	Pattern: contactData
Patient.contact:contact.gender	required	AdministrativeGender
Patient.contact:nameOfFather.relationship	extensible	Pattern: FTH
Patient.contact:nameOfFather.gender	required	AdministrativeGender
Patient.contact:nameOfMother.relationship	extensible	Pattern: MTH
Patient.contact:nameOfMother.gender	required	AdministrativeGender
Patient.communication.language	preferred	CommonLanguages Max Binding: AllLanguages
Patient.communication:languageOfCorrespondance.language	preferred	CommonLanguages Max Binding: AllLanguages
Patient.link.type	required	LinkType

Constraints

Constraints

Id	Path	Details	Requirements
dom-2	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	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	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Patient	A resource should have narrative for robust management : text.`div`.exists()
ch-pat-1	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	Patient	gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown'
ele-1	Patient.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:placeOfBirth	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:placeOfBirth	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:placeOfOrigin	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:placeOfOrigin	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:citizenship	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:citizenship	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ch-pat-3	Patient.extension:citizenship	ISO Country Alpha-2 or ISO Country Alpha-3 code : ((extension.where(url='code').valueCodeableConcept.coding.code.length()=2) and extension.where(url='code').valueCodeableConcept.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').valueCodeableConcept.coding.code.length() = 3) and extension.where(url='code').valueCodeableConcept.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ele-1	Patient.extension:religion	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:religion	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:EPR-SPID.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.identifier:EPR-SPID.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.identifier:EPR-SPID.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:EPR-SPID.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:EPR-SPID.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:EPR-SPID.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:EPR-SPID.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:EPR-SPID.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:AHVN13.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.identifier:AHVN13.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.identifier:AHVN13.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:AHVN13.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:AHVN13.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:AHVN13.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:AHVN13.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:AHVN13.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:LocalPid	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:LocalPid.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.identifier:LocalPid.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.identifier:LocalPid.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:LocalPid.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:LocalPid.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:LocalPid.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:LocalPid.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier:LocalPid.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.active	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ch-core-hm-1	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 valueCode='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').exists() and use='official')
ch-core-hm-2	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 valueCode='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').exists() and use='maiden'))
ch-core-hm-3	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	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()
ele-1	Patient.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.birthDate	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.deceased[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.maritalStatus	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.multipleBirth[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.photo	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
pat-1	Patient.contact	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()
ele-1	Patient.contact.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.contact.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.contact.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact.relationship	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.organization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:contact	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
pat-1	Patient.contact:contact	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()
ele-1	Patient.contact:contact.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.contact:contact.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact:contact.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.contact:contact.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact:contact.relationship	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:contact.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:contact.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:contact.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:contact.organization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:contact.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfFather	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
pat-1	Patient.contact:nameOfFather	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()
ele-1	Patient.contact:nameOfFather.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.contact:nameOfFather.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact:nameOfFather.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.contact:nameOfFather.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact:nameOfFather.relationship	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfFather.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfFather.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfFather.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfFather.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfFather.organization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfFather.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfMother	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
pat-1	Patient.contact:nameOfMother	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()
ele-1	Patient.contact:nameOfMother.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.contact:nameOfMother.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact:nameOfMother.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.contact:nameOfMother.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact:nameOfMother.relationship	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfMother.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfMother.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfMother.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfMother.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfMother.organization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact:nameOfMother.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.communication	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.communication.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.communication.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.communication.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.communication.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.communication.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.communication.preferred	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.communication:languageOfCorrespondance	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.communication:languageOfCorrespondance.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.communication:languageOfCorrespondance.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.communication:languageOfCorrespondance.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.communication:languageOfCorrespondance.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.communication:languageOfCorrespondance.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.communication:languageOfCorrespondance.preferred	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.generalPractitioner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.managingOrganization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.link	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.link.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.link.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.link.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.link.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.link.other	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.link.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())