This page is part of the CH EPR FHIR (R4) (v4.0.1: DSTU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: CH PDQm Patient Profile for $match Input

The PDQm Patient Profile for $match Input SHALL be provided as input to the ITI-119 transaction.

• While it is not REQUIRED that the input to $match be a valid FHIR instance, it is RECOMMENDED to supply as many elements as possible to facilitate matching.
• modifierExtension and implicitRules SHALL not be specified.
• The ChEprFhirBirthName profile is available to hold the mother's maiden name

Usage:

• Use this Resource Profile: CH PDQm Match Input Parameters Profile

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 PDQmMatchInput

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PDQmMatchInput	Information about an individual or animal receiving health care services
identifier	S	0..*	Identifier	An identifier for this patient
Slices for name		0..*	HumanName	A name associated with the patient Slice: Unordered, Open by profile:$this
name:HumanName	S	0..*	ChEprFhirHumanName	Name of a human - parts and usage
name:BirthName	S	0..1	ChEprFhirBirthName	The birthname of the patient
telecom		0..0
gender	S	0..1	code	male | female | other | unknown
birthDate	S	0..1	date	The date of birth for the individual
address	S	0..*	Address	An address for the individual
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PDQmMatchInput	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
Slices for extension				Content/Rules for all slices
MothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	An identifier for this patient ele-1: All FHIR elements must have a @value or children
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
Slices for name	Σ	0..*	HumanName	A name associated with the patient Slice: Unordered, Open by profile:$this ele-1: All FHIR elements must have a @value or children
name:HumanName	SC	0..*	ChEprFhirHumanName	Name of a human - parts and usage ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName'
name:BirthName	SC	0..1	ChEprFhirBirthName	The birthname of the patient ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	0..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 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-core-hm-1	error	Patient.name:HumanName, Patient.name:BirthName	if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	Patient.name:HumanName, Patient.name:BirthName	if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	Patient.name:HumanName, Patient.name:BirthName	ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()
ch-core-hm-4	error	Patient.name:HumanName, Patient.name:BirthName	ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()
ch-epr-fhir-1	error	Patient.name:HumanName	For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PDQmMatchInput	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
MothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
identifier	SΣ	0..*	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
Slices for name	Σ	0..*	HumanName	A name associated with the patient Slice: Unordered, Open by profile:$this
name:HumanName	SC	0..*	ChEprFhirHumanName	Name of a human - parts and usage ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName'
name:BirthName	SC	0..1	ChEprFhirBirthName	The birthname of the patient ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the 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		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
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
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.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-core-hm-1	error	Patient.name:HumanName, Patient.name:BirthName	if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	Patient.name:HumanName, Patient.name:BirthName	if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	Patient.name:HumanName, Patient.name:BirthName	ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()
ch-core-hm-4	error	Patient.name:HumanName, Patient.name:BirthName	ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()
ch-epr-fhir-1	error	Patient.name:HumanName	For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false
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	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 PDQmMatchInput

Summary

Must-Support: 6 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• CH EPR FHIR HumanName (http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-epr-fhir-humanname)
• CH EPR FHIR BirthName (http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-epr-fhir-birthname)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.name

Differential View

This structure is derived from PDQmMatchInput

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PDQmMatchInput	Information about an individual or animal receiving health care services
identifier	S	0..*	Identifier	An identifier for this patient
Slices for name		0..*	HumanName	A name associated with the patient Slice: Unordered, Open by profile:$this
name:HumanName	S	0..*	ChEprFhirHumanName	Name of a human - parts and usage
name:BirthName	S	0..1	ChEprFhirBirthName	The birthname of the patient
telecom		0..0
gender	S	0..1	code	male | female | other | unknown
birthDate	S	0..1	date	The date of birth for the individual
address	S	0..*	Address	An address for the individual
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PDQmMatchInput	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
Slices for extension				Content/Rules for all slices
MothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	An identifier for this patient ele-1: All FHIR elements must have a @value or children
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
Slices for name	Σ	0..*	HumanName	A name associated with the patient Slice: Unordered, Open by profile:$this ele-1: All FHIR elements must have a @value or children
name:HumanName	SC	0..*	ChEprFhirHumanName	Name of a human - parts and usage ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName'
name:BirthName	SC	0..1	ChEprFhirBirthName	The birthname of the patient ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	0..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 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-core-hm-1	error	Patient.name:HumanName, Patient.name:BirthName	if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	Patient.name:HumanName, Patient.name:BirthName	if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	Patient.name:HumanName, Patient.name:BirthName	ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()
ch-core-hm-4	error	Patient.name:HumanName, Patient.name:BirthName	ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()
ch-epr-fhir-1	error	Patient.name:HumanName	For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PDQmMatchInput	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
MothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
identifier	SΣ	0..*	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
Slices for name	Σ	0..*	HumanName	A name associated with the patient Slice: Unordered, Open by profile:$this
name:HumanName	SC	0..*	ChEprFhirHumanName	Name of a human - parts and usage ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName'
name:BirthName	SC	0..1	ChEprFhirBirthName	The birthname of the patient ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the 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		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
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
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.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-core-hm-1	error	Patient.name:HumanName, Patient.name:BirthName	if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	Patient.name:HumanName, Patient.name:BirthName	if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	Patient.name:HumanName, Patient.name:BirthName	ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()
ch-core-hm-4	error	Patient.name:HumanName, Patient.name:BirthName	ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()
ch-epr-fhir-1	error	Patient.name:HumanName	For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false
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	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 PDQmMatchInput

Summary

Must-Support: 6 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• CH EPR FHIR HumanName (http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-epr-fhir-humanname)
• CH EPR FHIR BirthName (http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-epr-fhir-birthname)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.name

Other representations of profile: CSV, Excel, Schematron