CH EKM (R4)
0.0.1 - ci-build Switzerland flag

CH EKM (R4), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/ch-ekm/ and changes regularly. See the Directory of published versions

Resource Profile: CH Ekm Patient Initials

Official URL: http://fhir.ch/ig/ch-ekm/StructureDefinition/ch-ekm-patient-initials Version: 0.0.1
Draft as of 2026-03-02 Computable Name: ChEkmPatientInitials

Copyright/Legal: CC0-1.0

Patient representation via Initials

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* ChEkmPatient CH Core Patient
Constraints: ch-pat-1, ch-pat-2, ch-ekm-gender-sync
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth Place of birth of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
.... extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
.... extension:citizenship SC 0..1 (Complex) Nation(s) where the patient claims citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
.... extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:genderIdentity 0..1 (Complex) The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity (required)
...... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
...... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
.... extension:biologicalSexAtBirth 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: CH EKM Biological Sex (required)
...... extension:type 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 76689-9
......... display 1..1 string Representation defined by the system
Fixed Value: Sex Assigned At Birth
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
.... extension:biologicalSex 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: CH EKM Biological Sex (required)
...... extension:type 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 46098-0
......... display 1..1 string Representation defined by the system
Fixed Value: Sex
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:AHVN13 SΣ 0..1 AHVN13Identifier OASI Number Switzerland

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name ΣC 1..1 CHCoreHumanName Whether the personal data is transmitted by using initials or full name is described under 'Guidance - Personal Data (Patient Name)'
Constraints: name-initials
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family Σ 1..1 string Family name (often called 'Surname')
..... Slices for extension Content/Rules for all slices
...... extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
.... given Σ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... Slices for extension Content/Rules for all slices
...... extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
... gender Σ 1..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate ΣC 1..1 date The date of birth for the individual
Constraints: ch-ekm-dateTime
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..1 CHCoreAddress An address for the individual
Slice: Unordered, Open by value:use
.... address:home SΣ 0..1 CHCoreAddress Residential address
..... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
...... Slices for extension Content/Rules for all slices
....... extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
..... state SΣ 0..1 string sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address.
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:countrycode C 1..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
... Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
Constraints: pat-1
.... 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 the address of the patient
Constraints: pat-1
..... 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
..... address 1..1 CHCoreAddressECH10 Address for the contact person
.... contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
..... 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
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:genderIdentity.​extension:value.value[x] Base required Gender Identity 📦2.0.0 THO v7.0
Patient.extension:biologicalSexAtBirth.​extension:value.value[x] Base required CH EKM Biological Sex 📦0.0.1 This IG
Patient.extension:biologicalSexAtBirth.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.0
Patient.extension:biologicalSexAtBirth.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.extension:biologicalSex.​extension:value.value[x] Base required CH EKM Biological Sex 📦0.0.1 This IG
Patient.extension:biologicalSex.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.0
Patient.extension:biologicalSex.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​state Base example eCH-0007 Canton Abbreviation 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning Patient.address:home.country.extension:countrycode ISO Country Alpha-2 or ISO Country Alpha-3 code ((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-ekm-dateTime error Patient.birthDate At least the format YYYY-MM-DD is required. $this.toString().length() >= 10
ch-ekm-gender-sync error Patient Administrative gender must be synchronized with biologicalSex (priority) or biologicalSexAtBirth. ((extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').exists()) or (extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '76689-9').exists())) implies (let sourceCode = iif(extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').exists(), extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').value.coding.code, extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '76689-9').value.coding.code) in ((sourceCode = '248153007' implies gender = 'male') and (sourceCode = '248152002' implies gender = 'female') and ((sourceCode = '32570681000036106' or sourceCode = '32570691000036108') implies gender = 'other')) )
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. 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 warning Patient.extension:citizenship ISO Country Alpha-2 or ISO Country Alpha-3 code ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
name-initials error Patient.name a name with initials given.exists() and given.first().exists() and (''+given.first()).length() = 1 and family.exists() and (''+family).length() = 1
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 ChEkmPatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* ChEkmPatient CH Core Patient
... name C 1..1 CHCoreHumanName Whether the personal data is transmitted by using initials or full name is described under 'Guidance - Personal Data (Patient Name)'
Constraints: name-initials
... telecom 0..0 A contact detail for the individual
... Slices for telecom Content/Rules for all slices
.... telecom:email 0..0 A contact detail for the individual
.... telecom:phone 0..0 A contact detail for the individual
.... telecom:internet 0..0 A contact detail for the individual
.... address:home 0..1 CHCoreAddress Residential address
..... line 0..0 Street name, number, direction & P.O. Box etc.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
name-initials error Patient.name a name with initials given.exists() and given.first().exists() and (''+given.first()).length() = 1 and family.exists() and (''+family).length() = 1
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* ChEkmPatient CH Core Patient
Constraints: ch-pat-1, ch-pat-2, ch-ekm-gender-sync
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth Place of birth of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
.... extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
.... extension:citizenship SC 0..1 (Complex) Nation(s) where the patient claims citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
.... extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:genderIdentity 0..1 (Complex) The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity (required)
...... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
...... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
.... extension:biologicalSexAtBirth 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: CH EKM Biological Sex (required)
...... extension:type 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 76689-9
......... display 1..1 string Representation defined by the system
Fixed Value: Sex Assigned At Birth
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
....... value[x] 0..1 Period Value of extension
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
.... extension:biologicalSex 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: CH EKM Biological Sex (required)
...... extension:type 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 46098-0
......... display 1..1 string Representation defined by the system
Fixed Value: Sex
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
....... value[x] 0..1 Period Value of extension
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..1 Identifier An identifier for this patient
Slice: Unordered, Open by value:$this
.... identifier:AHVN13 SΣ 0..1 AHVN13Identifier OASI Number Switzerland

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name ΣC 1..1 CHCoreHumanName Whether the personal data is transmitted by using initials or full name is described under 'Guidance - Personal Data (Patient Name)'
Constraints: name-initials
.... 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 | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string Family name (often called 'Surname')
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... given Σ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... prefix Σ 0..* string For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.
This repeating element order: Prefixes appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:salutationandtitle 0..* code For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... gender Σ 1..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate ΣC 1..1 date The date of birth for the individual
Constraints: ch-ekm-dateTime
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..1 CHCoreAddress An address for the individual
Slice: Unordered, Open by value:use
.... address:home SΣ 0..1 CHCoreAddress Residential address
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
...... value 0..1 string Primitive value for string
Max Length:1048576
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address.
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:countrycode C 1..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
...... value 0..1 string Primitive value for string
Max Length:1048576
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension: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
Constraints: pat-1
.... 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 the address of the patient
Constraints: pat-1
..... 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 1..1 CHCoreAddressECH10 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:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
..... 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
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.extension:genderIdentity.​extension:value.value[x] Base required Gender Identity 📦2.0.0 THO v7.0
Patient.extension:biologicalSexAtBirth.​extension:value.value[x] Base required CH EKM Biological Sex 📦0.0.1 This IG
Patient.extension:biologicalSexAtBirth.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.0
Patient.extension:biologicalSexAtBirth.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.extension:biologicalSex.​extension:value.value[x] Base required CH EKM Biological Sex 📦0.0.1 This IG
Patient.extension:biologicalSex.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.0
Patient.extension:biologicalSex.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:LocalPid.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​state Base example eCH-0007 Canton Abbreviation 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.maritalStatus Base extensible ChCoreMaritalStatus 📦3.3.0 CH Term v3.3
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:contact.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning Patient.address:home.country.extension:countrycode ISO Country Alpha-2 or ISO Country Alpha-3 code ((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-ekm-dateTime error Patient.birthDate At least the format YYYY-MM-DD is required. $this.toString().length() >= 10
ch-ekm-gender-sync error Patient Administrative gender must be synchronized with biologicalSex (priority) or biologicalSexAtBirth. ((extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').exists()) or (extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '76689-9').exists())) implies (let sourceCode = iif(extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').exists(), extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').value.coding.code, extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '76689-9').value.coding.code) in ((sourceCode = '248153007' implies gender = 'male') and (sourceCode = '248152002' implies gender = 'female') and ((sourceCode = '32570681000036106' or sourceCode = '32570691000036108') implies gender = 'other')) )
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. 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 warning Patient.extension:citizenship ISO Country Alpha-2 or ISO Country Alpha-3 code ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
name-initials error Patient.name a name with initials given.exists() and given.first().exists() and (''+given.first()).length() = 1 and family.exists() and (''+family).length() = 1
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 ChEkmPatient

Summary

Prohibited: 5 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* ChEkmPatient CH Core Patient
Constraints: ch-pat-1, ch-pat-2, ch-ekm-gender-sync
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth Place of birth of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
.... extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
.... extension:citizenship SC 0..1 (Complex) Nation(s) where the patient claims citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
.... extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:genderIdentity 0..1 (Complex) The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity (required)
...... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
...... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
.... extension:biologicalSexAtBirth 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: CH EKM Biological Sex (required)
...... extension:type 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 76689-9
......... display 1..1 string Representation defined by the system
Fixed Value: Sex Assigned At Birth
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
.... extension:biologicalSex 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: CH EKM Biological Sex (required)
...... extension:type 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 46098-0
......... display 1..1 string Representation defined by the system
Fixed Value: Sex
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:AHVN13 SΣ 0..1 AHVN13Identifier OASI Number Switzerland

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name ΣC 1..1 CHCoreHumanName Whether the personal data is transmitted by using initials or full name is described under 'Guidance - Personal Data (Patient Name)'
Constraints: name-initials
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family Σ 1..1 string Family name (often called 'Surname')
..... Slices for extension Content/Rules for all slices
...... extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
.... given Σ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... Slices for extension Content/Rules for all slices
...... extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
... gender Σ 1..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate ΣC 1..1 date The date of birth for the individual
Constraints: ch-ekm-dateTime
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..1 CHCoreAddress An address for the individual
Slice: Unordered, Open by value:use
.... address:home SΣ 0..1 CHCoreAddress Residential address
..... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
...... Slices for extension Content/Rules for all slices
....... extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
..... state SΣ 0..1 string sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address.
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:countrycode C 1..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
... Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by value:relationship
Constraints: pat-1
.... 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 the address of the patient
Constraints: pat-1
..... 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
..... address 1..1 CHCoreAddressECH10 Address for the contact person
.... contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
..... 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
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:genderIdentity.​extension:value.value[x] Base required Gender Identity 📦2.0.0 THO v7.0
Patient.extension:biologicalSexAtBirth.​extension:value.value[x] Base required CH EKM Biological Sex 📦0.0.1 This IG
Patient.extension:biologicalSexAtBirth.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.0
Patient.extension:biologicalSexAtBirth.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.extension:biologicalSex.​extension:value.value[x] Base required CH EKM Biological Sex 📦0.0.1 This IG
Patient.extension:biologicalSex.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.0
Patient.extension:biologicalSex.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​state Base example eCH-0007 Canton Abbreviation 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning Patient.address:home.country.extension:countrycode ISO Country Alpha-2 or ISO Country Alpha-3 code ((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-ekm-dateTime error Patient.birthDate At least the format YYYY-MM-DD is required. $this.toString().length() >= 10
ch-ekm-gender-sync error Patient Administrative gender must be synchronized with biologicalSex (priority) or biologicalSexAtBirth. ((extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').exists()) or (extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '76689-9').exists())) implies (let sourceCode = iif(extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').exists(), extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').value.coding.code, extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '76689-9').value.coding.code) in ((sourceCode = '248153007' implies gender = 'male') and (sourceCode = '248152002' implies gender = 'female') and ((sourceCode = '32570681000036106' or sourceCode = '32570691000036108') implies gender = 'other')) )
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. 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 warning Patient.extension:citizenship ISO Country Alpha-2 or ISO Country Alpha-3 code ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
name-initials error Patient.name a name with initials given.exists() and given.first().exists() and (''+given.first()).length() = 1 and family.exists() and (''+family).length() = 1
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()

Differential View

This structure is derived from ChEkmPatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* ChEkmPatient CH Core Patient
... name C 1..1 CHCoreHumanName Whether the personal data is transmitted by using initials or full name is described under 'Guidance - Personal Data (Patient Name)'
Constraints: name-initials
... telecom 0..0 A contact detail for the individual
... Slices for telecom Content/Rules for all slices
.... telecom:email 0..0 A contact detail for the individual
.... telecom:phone 0..0 A contact detail for the individual
.... telecom:internet 0..0 A contact detail for the individual
.... address:home 0..1 CHCoreAddress Residential address
..... line 0..0 Street name, number, direction & P.O. Box etc.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
name-initials error Patient.name a name with initials given.exists() and given.first().exists() and (''+given.first()).length() = 1 and family.exists() and (''+family).length() = 1

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* ChEkmPatient CH Core Patient
Constraints: ch-pat-1, ch-pat-2, ch-ekm-gender-sync
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth Place of birth of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace profiled by http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeofbirth
.... extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
.... extension:citizenship SC 0..1 (Complex) Nation(s) where the patient claims citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
.... extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:genderIdentity 0..1 (Complex) The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity (required)
...... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
...... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
.... extension:biologicalSexAtBirth 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: CH EKM Biological Sex (required)
...... extension:type 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 76689-9
......... display 1..1 string Representation defined by the system
Fixed Value: Sex Assigned At Birth
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
....... value[x] 0..1 Period Value of extension
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
.... extension:biologicalSex 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: CH EKM Biological Sex (required)
...... extension:type 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 46098-0
......... display 1..1 string Representation defined by the system
Fixed Value: Sex
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
....... value[x] 0..1 Period Value of extension
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..1 Identifier An identifier for this patient
Slice: Unordered, Open by value:$this
.... identifier:AHVN13 SΣ 0..1 AHVN13Identifier OASI Number Switzerland

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name ΣC 1..1 CHCoreHumanName Whether the personal data is transmitted by using initials or full name is described under 'Guidance - Personal Data (Patient Name)'
Constraints: name-initials
.... 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 | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string Family name (often called 'Surname')
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... given Σ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... prefix Σ 0..* string For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.
This repeating element order: Prefixes appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:salutationandtitle 0..* code For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... gender Σ 1..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate ΣC 1..1 date The date of birth for the individual
Constraints: ch-ekm-dateTime
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..1 CHCoreAddress An address for the individual
Slice: Unordered, Open by value:use
.... address:home SΣ 0..1 CHCoreAddress Residential address
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
...... value 0..1 string Primitive value for string
Max Length:1048576
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string sub-unit of country. canton-abbreviation is expected for a Swiss or Liechtenstein address.
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:countrycode C 1..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (required)
...... value 0..1 string Primitive value for string
Max Length:1048576
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension: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
Constraints: pat-1
.... 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 the address of the patient
Constraints: pat-1
..... 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 1..1 CHCoreAddressECH10 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:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
..... 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
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.extension:genderIdentity.​extension:value.value[x] Base required Gender Identity 📦2.0.0 THO v7.0
Patient.extension:biologicalSexAtBirth.​extension:value.value[x] Base required CH EKM Biological Sex 📦0.0.1 This IG
Patient.extension:biologicalSexAtBirth.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.0
Patient.extension:biologicalSexAtBirth.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.extension:biologicalSex.​extension:value.value[x] Base required CH EKM Biological Sex 📦0.0.1 This IG
Patient.extension:biologicalSex.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.0
Patient.extension:biologicalSex.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:LocalPid.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:home.​line.extension:addressLine1.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:addressLine2.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:street.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​line.extension:postOfficeBoxText.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.3.0 CH Term v3.3
Patient.address:home.​state Base example eCH-0007 Canton Abbreviation 📦3.3.0 CH Term v3.3
Patient.address:home.​country.extension:countrycode.​value[x] Base required BFS Verzeichnis der Staaten und Gebiete 📦3.3.0 CH Term v3.3
Patient.maritalStatus Base extensible ChCoreMaritalStatus 📦3.3.0 CH Term v3.3
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:contact.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning Patient.address:home.country.extension:countrycode ISO Country Alpha-2 or ISO Country Alpha-3 code ((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-ekm-dateTime error Patient.birthDate At least the format YYYY-MM-DD is required. $this.toString().length() >= 10
ch-ekm-gender-sync error Patient Administrative gender must be synchronized with biologicalSex (priority) or biologicalSexAtBirth. ((extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').exists()) or (extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '76689-9').exists())) implies (let sourceCode = iif(extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').exists(), extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '46098-0').value.coding.code, extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').where(type.coding.code = '76689-9').value.coding.code) in ((sourceCode = '248153007' implies gender = 'male') and (sourceCode = '248152002' implies gender = 'female') and ((sourceCode = '32570681000036106' or sourceCode = '32570691000036108') implies gender = 'other')) )
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. 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 warning Patient.extension:citizenship ISO Country Alpha-2 or ISO Country Alpha-3 code ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
name-initials error Patient.name a name with initials given.exists() and given.first().exists() and (''+given.first()).length() = 1 and family.exists() and (''+family).length() = 1
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 ChEkmPatient

Summary

Prohibited: 5 elements

 

Other representations of profile: CSV, Excel, Schematron