CH Core (R4)
4.0.1 - trial-use
This page is part of the CH Core (R4) (v4.0.1: STU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient | Version: 4.0.1 | |||
Active as of 2023-12-28 | Computable Name: CHCorePatient | |||
Copyright/Legal: CC0-1.0 |
Core patient definition in the swiss context. Relevant are definitions by the eCH-0010 V7.0 data standard mailing address and eCH-0011 V8.1 data standard pesond data. The CH Core Patient is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements in Switzerland. See also BFS for further information
Core patient demographics which can be shared
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | Patient | CH Core Patient ch-pat-1: At least one HumanName with given and family name must be provided. ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
placeOfBirth | 0..1 | CHCoreAddressEch11PlaceOfBirth | Place of birth of patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth | |
placeOfOrigin | 0..* | CHCoreAddressECH11PlaceOfOrigin | Place of origin(s) of patient URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin | |
citizenship | C | 0..* | (Complex) | Citizenship(s) of patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code |
religion | 0..1 | CodeableConcept | Religion of patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (extensible) | |
Slices for identifier | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this | |
identifier:All Slices | Content/Rules for all slices | |||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
identifier:EPR-SPID | 0..* | EPRSPIDIdentifier | EPR-SPID Required Pattern: At least the following | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | |
identifier:AHVN13 | 0..* | AHVN13Identifier | AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points) Required Pattern: At least the following | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 | |
identifier:LocalPid | 0..* | Identifier | Local patient identifier(s) Required Pattern: At least the following | |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
identifier:insuranceCardNumber | 0..* | VEKAIdentifier | Insurance card number of the patient (20 digits) Required Pattern: At least the following | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 | |
name | 0..* | CHCoreHumanName | Name of a human - parts and usage | |
Slices for telecom | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | |
telecom:All Slices | Content/Rules for all slices | |||
system | 1..1 | code | phone | fax | email | pager | url | sms | other | |
value | 1..1 | string | The actual contact point details | |
telecom:email | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email | |
telecom:phone | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone | |
telecom:internet | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet | |
gender | 0..1 | code | male | female | other | |
birthDate | 0..1 | date | The date of birth for the individual | |
deceased[x] | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not | |
address | 0..* | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible) | |
maritalDataSeparation | 0..1 | CodeableConcept | MaritalData Separation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type | |
Slices for contact | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:relationship | |
contact:contact | 0..1 | BackboneElement | Contact data if it is not address of patient | |
relationship | 1..1 | CodeableConcept | The kind of relationship Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contactData | |
telecom | 0..0 | |||
address | 1..1 | CHCoreAddressECH10 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
contact:nameOfParent | 0..* | BackboneElement | Name of parent | |
relationship | 1..1 | CodeableConcept | The kind of relationship Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
name | 1..1 | HumanName | A name associated with the contact person | |
Slices for communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health Slice: Unordered, Open by value:preferred | |
communication:languageOfCorrespondence | 0..1 | BackboneElement | Language of correspondence | |
preferred | 1..1 | boolean | Language preference indicator Fixed Value: true | |
Documentation for this format |
Path | Conformance | ValueSet |
Patient.maritalStatus | extensible | ChCoreMaritalStatus |
Id | Grade | Path(s) | Details | Requirements |
ch-pat-1 | error | Patient | At least one HumanName with given and family name must be provided. : name.where(family.exists() and given.exists()).count()>0 or name.empty() | |
ch-pat-2 | warning | Patient | gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown' | |
ch-pat-3 | error | Patient.extension:citizenship | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | Patient | CH Core Patient ch-pat-1: At least one HumanName with given and family name must be provided. ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
placeOfBirth | 0..1 | CHCoreAddressEch11PlaceOfBirth | Place of birth of patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth | |||||
placeOfOrigin | 0..* | CHCoreAddressECH11PlaceOfOrigin | Place of origin(s) of patient URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin | |||||
citizenship | C | 0..* | (Complex) | Citizenship(s) of patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code | ||||
religion | 0..1 | CodeableConcept | Religion of patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (extensible) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:EPR-SPID | 0..* | EPRSPIDIdentifier | EPR-SPID Required Pattern: At least the following | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | |||||
identifier:AHVN13 | 0..* | AHVN13Identifier | AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points) Required Pattern: At least the following | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 | |||||
identifier:LocalPid | Σ | 0..* | Identifier | Local patient identifier(s) Required Pattern: At least the following | ||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
identifier:insuranceCardNumber | 0..* | VEKAIdentifier | Insurance card number of the patient (20 digits) Required Pattern: At least the following | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 | |||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | C | 0..* | CHCoreHumanName | Name of a human - parts and usage | ||||
Slices for telecom | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||
telecom:All Slices | Content/Rules for all slices | |||||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | Σ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email | ||||
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone | ||||
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet | ||||
gender | Σ | 0..1 | code | male | female | other Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 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 | C | 0..* | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible) | |||||
maritalDataSeparation | 0..1 | CodeableConcept | MaritalData Separation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type | |||||
Slices for contact | C | 0..* | BackboneElement | 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 | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
contact:contact | C | 0..1 | BackboneElement | Contact data if it is not address of patient | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11 | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contactData | |||||
address | C | 1..1 | CHCoreAddressECH10 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
contact:nameOfParent | C | 0..* | BackboneElement | Name of parent | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |||||
name | 1..1 | HumanName | A name associated with the contact person | |||||
Slices for communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health Slice: Unordered, Open by value:preferred | |||||
communication:All Slices | Content/Rules for all slices | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
communication:languageOfCorrespondence | 0..1 | BackboneElement | Language of correspondence | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 1..1 | boolean | Language preference indicator Fixed Value: true | |||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.identifier.use | required | IdentifierUse | ||||
Patient.telecom.system | required | ContactPointSystem | ||||
Patient.telecom.use | required | ContactPointUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.maritalStatus | extensible | ChCoreMaritalStatus | ||||
Patient.contact:contact.relationship | extensible | Pattern: contactData | ||||
Patient.contact:nameOfParent.relationship | extensible | Pattern: PRN | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.communication:languageOfCorrespondence.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
ch-addr-2 | error | Patient.address, Patient.contact:contact.address | For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. : country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))) | |
ch-core-hm-1 | error | Patient.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official') | |
ch-core-hm-2 | error | Patient.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden')) | |
ch-core-hm-3 | error | Patient.name | ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count() | |
ch-core-hm-4 | error | Patient.name | ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count() | |
ch-pat-1 | error | Patient | At least one HumanName with given and family name must be provided. : name.where(family.exists() and given.exists()).count()>0 or name.empty() | |
ch-pat-2 | warning | Patient | gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown' | |
ch-pat-3 | error | Patient.extension:citizenship | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) | |
cpt-2 | error | Patient.telecom:email, Patient.telecom:phone, Patient.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | Patient | CH Core Patient ch-pat-1: At least one HumanName with given and family name must be provided. ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
placeOfBirth | 0..1 | CHCoreAddressEch11PlaceOfBirth | Place of birth of patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth | |||||
placeOfOrigin | 0..* | CHCoreAddressECH11PlaceOfOrigin | Place of origin(s) of patient URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin | |||||
citizenship | C | 0..* | (Complex) | Citizenship(s) of patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code | ||||
religion | 0..1 | CodeableConcept | Religion of patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (extensible) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:EPR-SPID | 0..* | EPRSPIDIdentifier | EPR-SPID Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:AHVN13 | 0..* | AHVN13Identifier | AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points) Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:LocalPid | Σ | 0..* | Identifier | Local patient identifier(s) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:insuranceCardNumber | 0..* | VEKAIdentifier | Insurance card number of the patient (20 digits) Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | C | 0..* | CHCoreHumanName | Name of a human - parts and usage | ||||
Slices for telecom | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||
telecom:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | Σ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email | ||||
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone | ||||
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet | ||||
gender | Σ | 0..1 | code | male | female | other Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 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 | C | 0..* | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
maritalDataSeparation | 0..1 | CodeableConcept | MaritalData Separation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
Slices for contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:relationship | ||||
contact:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
address | 0..1 | Address | Address for the contact person | |||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
contact:contact | C | 0..1 | BackboneElement | Contact data if it is not address of patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contactData | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
address | C | 1..1 | CHCoreAddressECH10 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
contact:nameOfParent | C | 0..* | BackboneElement | Name of parent | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
name | 1..1 | HumanName | A name associated with the contact person | |||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
address | 0..1 | Address | Address for the contact person | |||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
Slices for communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health Slice: Unordered, Open by value:preferred | |||||
communication:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
communication:languageOfCorrespondence | 0..1 | BackboneElement | Language of correspondence | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 1..1 | boolean | Language preference indicator Fixed Value: true | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.identifier.use | required | IdentifierUse | ||||
Patient.identifier.type | extensible | Identifier Type Codes | ||||
Patient.telecom.system | required | ContactPointSystem | ||||
Patient.telecom.use | required | ContactPointUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.maritalStatus | extensible | 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:nameOfParent.relationship | extensible | Pattern: PRN | ||||
Patient.contact:nameOfParent.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.communication:languageOfCorrespondence.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
ch-addr-2 | error | Patient.address, Patient.contact:contact.address | For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. : country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))) | |
ch-core-hm-1 | error | Patient.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official') | |
ch-core-hm-2 | error | Patient.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden')) | |
ch-core-hm-3 | error | Patient.name | ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count() | |
ch-core-hm-4 | error | Patient.name | ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count() | |
ch-pat-1 | error | Patient | At least one HumanName with given and family name must be provided. : name.where(family.exists() and given.exists()).count()>0 or name.empty() | |
ch-pat-2 | warning | Patient | gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown' | |
ch-pat-3 | error | Patient.extension:citizenship | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) | |
cpt-2 | error | Patient.telecom:email, Patient.telecom:phone, Patient.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from Patient
Summary
Mandatory: 0 element (9 nested mandatory elements)
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | Patient | CH Core Patient ch-pat-1: At least one HumanName with given and family name must be provided. ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
placeOfBirth | 0..1 | CHCoreAddressEch11PlaceOfBirth | Place of birth of patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth | |
placeOfOrigin | 0..* | CHCoreAddressECH11PlaceOfOrigin | Place of origin(s) of patient URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin | |
citizenship | C | 0..* | (Complex) | Citizenship(s) of patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code |
religion | 0..1 | CodeableConcept | Religion of patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (extensible) | |
Slices for identifier | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this | |
identifier:All Slices | Content/Rules for all slices | |||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
identifier:EPR-SPID | 0..* | EPRSPIDIdentifier | EPR-SPID Required Pattern: At least the following | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | |
identifier:AHVN13 | 0..* | AHVN13Identifier | AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points) Required Pattern: At least the following | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 | |
identifier:LocalPid | 0..* | Identifier | Local patient identifier(s) Required Pattern: At least the following | |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
identifier:insuranceCardNumber | 0..* | VEKAIdentifier | Insurance card number of the patient (20 digits) Required Pattern: At least the following | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 | |
name | 0..* | CHCoreHumanName | Name of a human - parts and usage | |
Slices for telecom | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | |
telecom:All Slices | Content/Rules for all slices | |||
system | 1..1 | code | phone | fax | email | pager | url | sms | other | |
value | 1..1 | string | The actual contact point details | |
telecom:email | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email | |
telecom:phone | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone | |
telecom:internet | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet | |
gender | 0..1 | code | male | female | other | |
birthDate | 0..1 | date | The date of birth for the individual | |
deceased[x] | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not | |
address | 0..* | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible) | |
maritalDataSeparation | 0..1 | CodeableConcept | MaritalData Separation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type | |
Slices for contact | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:relationship | |
contact:contact | 0..1 | BackboneElement | Contact data if it is not address of patient | |
relationship | 1..1 | CodeableConcept | The kind of relationship Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contactData | |
telecom | 0..0 | |||
address | 1..1 | CHCoreAddressECH10 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
contact:nameOfParent | 0..* | BackboneElement | Name of parent | |
relationship | 1..1 | CodeableConcept | The kind of relationship Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
name | 1..1 | HumanName | A name associated with the contact person | |
Slices for communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health Slice: Unordered, Open by value:preferred | |
communication:languageOfCorrespondence | 0..1 | BackboneElement | Language of correspondence | |
preferred | 1..1 | boolean | Language preference indicator Fixed Value: true | |
Documentation for this format |
Path | Conformance | ValueSet |
Patient.maritalStatus | extensible | ChCoreMaritalStatus |
Id | Grade | Path(s) | Details | Requirements |
ch-pat-1 | error | Patient | At least one HumanName with given and family name must be provided. : name.where(family.exists() and given.exists()).count()>0 or name.empty() | |
ch-pat-2 | warning | Patient | gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown' | |
ch-pat-3 | error | Patient.extension:citizenship | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | Patient | CH Core Patient ch-pat-1: At least one HumanName with given and family name must be provided. ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
placeOfBirth | 0..1 | CHCoreAddressEch11PlaceOfBirth | Place of birth of patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth | |||||
placeOfOrigin | 0..* | CHCoreAddressECH11PlaceOfOrigin | Place of origin(s) of patient URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin | |||||
citizenship | C | 0..* | (Complex) | Citizenship(s) of patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code | ||||
religion | 0..1 | CodeableConcept | Religion of patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (extensible) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:EPR-SPID | 0..* | EPRSPIDIdentifier | EPR-SPID Required Pattern: At least the following | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | |||||
identifier:AHVN13 | 0..* | AHVN13Identifier | AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points) Required Pattern: At least the following | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 | |||||
identifier:LocalPid | Σ | 0..* | Identifier | Local patient identifier(s) Required Pattern: At least the following | ||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
identifier:insuranceCardNumber | 0..* | VEKAIdentifier | Insurance card number of the patient (20 digits) Required Pattern: At least the following | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 | |||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | C | 0..* | CHCoreHumanName | Name of a human - parts and usage | ||||
Slices for telecom | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||
telecom:All Slices | Content/Rules for all slices | |||||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | Σ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email | ||||
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone | ||||
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet | ||||
gender | Σ | 0..1 | code | male | female | other Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 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 | C | 0..* | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible) | |||||
maritalDataSeparation | 0..1 | CodeableConcept | MaritalData Separation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type | |||||
Slices for contact | C | 0..* | BackboneElement | 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 | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
contact:contact | C | 0..1 | BackboneElement | Contact data if it is not address of patient | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11 | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contactData | |||||
address | C | 1..1 | CHCoreAddressECH10 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
contact:nameOfParent | C | 0..* | BackboneElement | Name of parent | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |||||
name | 1..1 | HumanName | A name associated with the contact person | |||||
Slices for communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health Slice: Unordered, Open by value:preferred | |||||
communication:All Slices | Content/Rules for all slices | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
communication:languageOfCorrespondence | 0..1 | BackboneElement | Language of correspondence | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 1..1 | boolean | Language preference indicator Fixed Value: true | |||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.identifier.use | required | IdentifierUse | ||||
Patient.telecom.system | required | ContactPointSystem | ||||
Patient.telecom.use | required | ContactPointUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.maritalStatus | extensible | ChCoreMaritalStatus | ||||
Patient.contact:contact.relationship | extensible | Pattern: contactData | ||||
Patient.contact:nameOfParent.relationship | extensible | Pattern: PRN | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.communication:languageOfCorrespondence.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
ch-addr-2 | error | Patient.address, Patient.contact:contact.address | For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. : country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))) | |
ch-core-hm-1 | error | Patient.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official') | |
ch-core-hm-2 | error | Patient.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden')) | |
ch-core-hm-3 | error | Patient.name | ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count() | |
ch-core-hm-4 | error | Patient.name | ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count() | |
ch-pat-1 | error | Patient | At least one HumanName with given and family name must be provided. : name.where(family.exists() and given.exists()).count()>0 or name.empty() | |
ch-pat-2 | warning | Patient | gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown' | |
ch-pat-3 | error | Patient.extension:citizenship | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) | |
cpt-2 | error | Patient.telecom:email, Patient.telecom:phone, Patient.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | Patient | CH Core Patient ch-pat-1: At least one HumanName with given and family name must be provided. ch-pat-2: gender unknown is currently not used in Switzerland in eCH and the EPR | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
placeOfBirth | 0..1 | CHCoreAddressEch11PlaceOfBirth | Place of birth of patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth | |||||
placeOfOrigin | 0..* | CHCoreAddressECH11PlaceOfOrigin | Place of origin(s) of patient URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin | |||||
citizenship | C | 0..* | (Complex) | Citizenship(s) of patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code | ||||
religion | 0..1 | CodeableConcept | Religion of patient URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (extensible) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:EPR-SPID | 0..* | EPRSPIDIdentifier | EPR-SPID Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:AHVN13 | 0..* | AHVN13Identifier | AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points) Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:LocalPid | Σ | 0..* | Identifier | Local patient identifier(s) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:insuranceCardNumber | 0..* | VEKAIdentifier | Insurance card number of the patient (20 digits) Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | C | 0..* | CHCoreHumanName | Name of a human - parts and usage | ||||
Slices for telecom | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||
telecom:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | Σ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email | ||||
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone | ||||
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet | ||||
gender | Σ | 0..1 | code | male | female | other Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 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 | C | 0..* | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (extensible) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
maritalDataSeparation | 0..1 | CodeableConcept | MaritalData Separation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-maritaldata-separation Binding: eCH-011 MaritalData Separation (extensible): ValueSet separation type | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
Slices for contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:relationship | ||||
contact:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
address | 0..1 | Address | Address for the contact person | |||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
contact:contact | C | 0..1 | BackboneElement | Contact data if it is not address of patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contactData | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
address | C | 1..1 | CHCoreAddressECH10 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
contact:nameOfParent | C | 0..* | BackboneElement | Name of parent | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
name | 1..1 | HumanName | A name associated with the contact person | |||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
address | 0..1 | Address | Address for the contact person | |||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
Slices for communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health Slice: Unordered, Open by value:preferred | |||||
communication:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
communication:languageOfCorrespondence | 0..1 | BackboneElement | Language of correspondence | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 1..1 | boolean | Language preference indicator Fixed Value: true | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.identifier.use | required | IdentifierUse | ||||
Patient.identifier.type | extensible | Identifier Type Codes | ||||
Patient.telecom.system | required | ContactPointSystem | ||||
Patient.telecom.use | required | ContactPointUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.maritalStatus | extensible | 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:nameOfParent.relationship | extensible | Pattern: PRN | ||||
Patient.contact:nameOfParent.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.communication:languageOfCorrespondence.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
ch-addr-2 | error | Patient.address, Patient.contact:contact.address | For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. : country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))) | |
ch-core-hm-1 | error | Patient.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official') | |
ch-core-hm-2 | error | Patient.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden')) | |
ch-core-hm-3 | error | Patient.name | ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count() | |
ch-core-hm-4 | error | Patient.name | ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count() | |
ch-pat-1 | error | Patient | At least one HumanName with given and family name must be provided. : name.where(family.exists() and given.exists()).count()>0 or name.empty() | |
ch-pat-2 | warning | Patient | gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown' | |
ch-pat-3 | error | Patient.extension:citizenship | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) | |
cpt-2 | error | Patient.telecom:email, Patient.telecom:phone, Patient.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from Patient
Summary
Mandatory: 0 element (9 nested mandatory elements)
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron