CH Core (R4)
1.1.0 - CI build

CH Core (R4), published by HL7 Switzerland. This is not an authorized publication; it is the continuous build for version 1.1.0). This version is based on the current content of https://github.com/hl7ch/ch-core/ and changes regularly. See the Directory of published versions

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.

This structure is derived from CHCorePatient

Summary

Mandatory: 4 elements
Prohibited: 2 elements

This structure is derived from CHCorePatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*CHCorePatientCH Core Patient EPR (to include the patient in an EPR document)
... identifier 1..*IdentifierAn identifier for this patient
... identifier:EPR-SPID 0..0
... identifier:AHVN13 0..0
... telecom 0..*ContactPointA contact detail for the individual
... gender 1..1codemale | female | other
... birthDate 1..1dateThe date of birth for the individual
... address 0..*CHCoreAddressAn address for the individual

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*CHCorePatientCH Core Patient EPR (to include the patient in an EPR document)
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ch-core-patient-ech-11-placeofbirth I0..1AddressPlace 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
... ch-core-patient-ech-11-placeoforigin I0..*AddressPlace of origin(s) of patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
... patient-citizenship I0..*(Complex)Citizenships of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
... patient-religion I0..1CodeableConceptReligion of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (extensible)
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI1..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:LocalPid ΣI0..*IdentifierLocal patient identifiers

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name I1..*CHCoreHumanNameA name associated with the patient
... telecom ΣI0..*ContactPointA contact detail for the individual
... gender ΣI1..1codemale | female | other
Binding: AdministrativeGender (required)
... birthDate ΣI1..1dateThe date of birth for the individual
... deceased[x] ?!ΣI0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address I0..*CHCoreAddressAn address for the individual
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: ChCoreMaritalStatus (required)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*AttachmentImage of the patient
... contact I0..*(Slice Definition)A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
.... contact:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship I0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
..... name I0..1HumanNameA name associated with the contact person
..... telecom I0..*ContactPointA contact detail for the person
..... address I0..1AddressAddress for the contact person
..... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
..... organization I0..1Reference(Organization)Organization that is associated with the contact
..... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:contact I0..1BackboneElementContactdata if it is not address of patient
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship I0..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: contactData
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name I0..1HumanNameA name associated with the contact person
..... address I1..1CHCoreAddressECH10Address for the contact person
..... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
..... organization I0..1Reference(Organization)Organization that is associated with the contact
..... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:nameOfFather I0..1BackboneElementName of Father
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship I0..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FTH
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name I1..1HumanNameA name associated with the contact person
..... telecom I0..*ContactPointA contact detail for the person
..... address I0..1AddressAddress for the contact person
..... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
..... organization I0..1Reference(Organization)Organization that is associated with the contact
..... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:nameOfMother I0..1BackboneElementName of Mother
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship I0..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MTH
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name I1..1HumanNameA name associated with the contact person
..... telecom I0..*ContactPointA contact detail for the person
..... address I0..1AddressAddress for the contact person
..... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
..... organization I0..1Reference(Organization)Organization that is associated with the contact
..... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication I0..*(Slice Definition)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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
..... preferred I0..1booleanLanguage preference indicator
.... communication:languageOfCorrespondance I0..1BackboneElementA language which may be used to communicate with the patient about his or her health
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
..... preferred I1..1booleanLanguage preference indicator
Fixed Value: true
... generalPractitioner I0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

This structure is derived from CHCorePatient

Summary

Mandatory: 4 elements
Prohibited: 2 elements

Differential View

This structure is derived from CHCorePatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*CHCorePatientCH Core Patient EPR (to include the patient in an EPR document)
... identifier 1..*IdentifierAn identifier for this patient
... identifier:EPR-SPID 0..0
... identifier:AHVN13 0..0
... telecom 0..*ContactPointA contact detail for the individual
... gender 1..1codemale | female | other
... birthDate 1..1dateThe date of birth for the individual
... address 0..*CHCoreAddressAn address for the individual

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*CHCorePatientCH Core Patient EPR (to include the patient in an EPR document)
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ch-core-patient-ech-11-placeofbirth I0..1AddressPlace 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
... ch-core-patient-ech-11-placeoforigin I0..*AddressPlace of origin(s) of patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
... patient-citizenship I0..*(Complex)Citizenships of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
... patient-religion I0..1CodeableConceptReligion of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (extensible)
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI1..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:LocalPid ΣI0..*IdentifierLocal patient identifiers

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name I1..*CHCoreHumanNameA name associated with the patient
... telecom ΣI0..*ContactPointA contact detail for the individual
... gender ΣI1..1codemale | female | other
Binding: AdministrativeGender (required)
... birthDate ΣI1..1dateThe date of birth for the individual
... deceased[x] ?!ΣI0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address I0..*CHCoreAddressAn address for the individual
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: ChCoreMaritalStatus (required)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*AttachmentImage of the patient
... contact I0..*(Slice Definition)A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
.... contact:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship I0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
..... name I0..1HumanNameA name associated with the contact person
..... telecom I0..*ContactPointA contact detail for the person
..... address I0..1AddressAddress for the contact person
..... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
..... organization I0..1Reference(Organization)Organization that is associated with the contact
..... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:contact I0..1BackboneElementContactdata if it is not address of patient
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship I0..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: contactData
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name I0..1HumanNameA name associated with the contact person
..... address I1..1CHCoreAddressECH10Address for the contact person
..... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
..... organization I0..1Reference(Organization)Organization that is associated with the contact
..... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:nameOfFather I0..1BackboneElementName of Father
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship I0..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FTH
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name I1..1HumanNameA name associated with the contact person
..... telecom I0..*ContactPointA contact detail for the person
..... address I0..1AddressAddress for the contact person
..... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
..... organization I0..1Reference(Organization)Organization that is associated with the contact
..... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:nameOfMother I0..1BackboneElementName of Mother
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... relationship I0..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MTH
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name I1..1HumanNameA name associated with the contact person
..... telecom I0..*ContactPointA contact detail for the person
..... address I0..1AddressAddress for the contact person
..... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
..... organization I0..1Reference(Organization)Organization that is associated with the contact
..... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication I0..*(Slice Definition)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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
..... preferred I0..1booleanLanguage preference indicator
.... communication:languageOfCorrespondance I0..1BackboneElementA language which may be used to communicate with the patient about his or her health
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
..... preferred I1..1booleanLanguage preference indicator
Fixed Value: true
... generalPractitioner I0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Patient.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.identifier:EPR-SPID.userequiredIdentifierUse
Patient.identifier:EPR-SPID.typeextensibleIdentifier Type Codes
Patient.identifier:AHVN13.userequiredIdentifierUse
Patient.identifier:AHVN13.typeextensibleIdentifier Type Codes
Patient.identifier:LocalPid.userequiredIdentifierUse
Patient.identifier:LocalPid.typeextensibleIdentifier Type Codes
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusrequiredChCoreMaritalStatus
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.contact:contact.relationshipextensiblePattern: contactData
Patient.contact:contact.genderrequiredAdministrativeGender
Patient.contact:nameOfFather.relationshipextensiblePattern: FTH
Patient.contact:nameOfFather.genderrequiredAdministrativeGender
Patient.contact:nameOfMother.relationshipextensiblePattern: MTH
Patient.contact:nameOfMother.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.communication:languageOfCorrespondance.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.link.typerequiredLinkType

Constraints

Constraints

IdPathDetailsRequirements
dom-2PatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3PatientIf 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-4PatientIf 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-5PatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6PatientA resource should have narrative for robust management
: text.`div`.exists()
ch-pat-1PatientAt 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-2Patientgender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ele-1Patient.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.extension:placeOfBirthAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.extension:placeOfBirthMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.extension:placeOfOriginAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.extension:placeOfOriginMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.extension:citizenshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.extension:citizenshipMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ch-pat-3Patient.extension:citizenshipISO 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-1Patient.extension:religionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.extension:religionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:EPR-SPID.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.identifier:EPR-SPID.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.identifier:EPR-SPID.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:EPR-SPID.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:EPR-SPID.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:EPR-SPID.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:EPR-SPID.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:EPR-SPID.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:AHVN13.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.identifier:AHVN13.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.identifier:AHVN13.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:AHVN13.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:AHVN13.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:AHVN13.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:AHVN13.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:AHVN13.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:LocalPidAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:LocalPid.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.identifier:LocalPid.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.identifier:LocalPid.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:LocalPid.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:LocalPid.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:LocalPid.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:LocalPid.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.identifier:LocalPid.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ch-core-hm-1Patient.nameif 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-2Patient.nameif 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-3Patient.namech-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-4Patient.namech-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-1Patient.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.deceased[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.maritalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.multipleBirth[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.photoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pat-1Patient.contactSHALL 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-1Patient.contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pat-1Patient.contact:contactSHALL 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-1Patient.contact:contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact:contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact:contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact:contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact:contact.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:contact.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:contact.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:contact.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfFatherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pat-1Patient.contact:nameOfFatherSHALL 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-1Patient.contact:nameOfFather.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact:nameOfFather.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact:nameOfFather.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact:nameOfFather.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact:nameOfFather.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfFather.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfFather.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfFather.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfFather.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfFather.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfFather.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfMotherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pat-1Patient.contact:nameOfMotherSHALL 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-1Patient.contact:nameOfMother.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact:nameOfMother.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact:nameOfMother.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact:nameOfMother.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact:nameOfMother.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfMother.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfMother.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfMother.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfMother.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfMother.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact:nameOfMother.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communication.preferredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communication:languageOfCorrespondanceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communication:languageOfCorrespondance.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.communication:languageOfCorrespondance.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.communication:languageOfCorrespondance.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.communication:languageOfCorrespondance.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.communication:languageOfCorrespondance.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communication:languageOfCorrespondance.preferredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.generalPractitionerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.link.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.link.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.link.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.link.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.link.otherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.link.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())