CH EPREG (R4)
1.0.0-ci-build - ci-build Switzerland flag

CH EPREG (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-epreg/ and changes regularly. See the Directory of published versions

Resource Profile: CH EPREG Patient: Mother

Official URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-patient-mother Version: 1.0.0-ci-build
Active as of 2025-09-16 Computable Name: ChEpregPatientMother

Copyright/Legal: CC0-1.0

This profile constrains the Patient resource to represent the pregnant individual.

Usages:

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..* CHCorePatientEPR CH EPREG Patient: Mother
Constraints: ch-pat-1, ch-pat-2, ch-pat-1-epr
... 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 C 0..* (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:pronoun 0..1 (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:LocalPid Σ 0..* Identifier Local patient identifier(s)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 0..1 uri The namespace for the identifier value
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:insuranceCardNumber Σ 0..* VEKAIdentifier Insurance card number of the patient (20 digits)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 1..* CHCoreHumanName A name associated with the patient
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full 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 (extensible)
.... given Σ 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 (extensible)
.... 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
..... Slices for extension Content/Rules for all slices
...... 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)
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..* CHCoreContactPointECH46Email A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... Slices for extension Content/Rules for all slices
....... extension:emailCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory
Binding: eCH-0046 Email Category (extensible)
.... telecom:phone SΣ 0..* CHCoreContactPointECH46Phone A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... Slices for extension Content/Rules for all slices
....... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
.... telecom:internet Σ 0..* CHCoreContactPointECH46Internet A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... Slices for extension Content/Rules for all slices
....... extension:internetCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-internetcategory
Binding: eCH-0046 Internet Category (extensible)
... gender Σ 1..1 code male | female | other | unknown* (* see warning 'ch-pat-2')
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* CHCoreAddress An address for the individual
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... Slices for extension Content/Rules for all slices
...... extension:addressLine1 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine1
...... extension:addressLine2 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine2
...... extension:street 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: street
...... extension:streetName 0..1 string street part of the street line, e.g. withouth housenumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... extension:houseNumber 0..1 string houseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... extension:unitID 0..1 string unitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
...... extension:postOfficeBoxText 0..1 (Complex) Postbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: postOfficeBoxText
...... extension:postOfficeBoxNumber 0..1 string Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... 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
.... 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 Content/Rules for all slices
...... extension:countrycode C 0..1 Coding ISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Binding Description: (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
Constraints: ch-addr-1
... 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
.... contact:emergency SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:primaryContact 0..1 boolean CH EPREG Extension: Primary Contact
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-primary-contact
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 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/v2-0131
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C
....... 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 S 0..1 HumanName A name associated with the contact person
...... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
...... family SΣ 0..1 string Family name (often called 'Surname')
...... given SΣ 0..* 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 telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ Slices for extension Content/Rules for all slices
......... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
.... contact:guardian C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 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: GUARD
....... 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 S 0..1 HumanName A name associated with the contact person
...... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
...... family SΣ 0..1 string Family name (often called 'Surname')
...... given SΣ 0..* 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 telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... telecom:email 0..* CHCoreContactPointECH46Email A contact detail for the person
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ Slices for extension Content/Rules for all slices
......... extension:emailCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory
Binding: eCH-0046 Email Category (extensible)
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ Slices for extension Content/Rules for all slices
......... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
... Slices for communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Slice: Unordered, Open by value:preferred
.... communication:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... communication:languageOfCorrespondence 0..1 BackboneElement Language of correspondence
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... preferred 1..1 boolean Language preference indicator
Fixed Value: true
... Slices for link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by value:type
.... link:All Slices Content/Rules for all slices
..... 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.
.... link:child ?!Σ 0..* BackboneElement Link to the mother's RelatedPerson resource pointing to the child's Patient resource
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... other Σ 1..1 Reference(CH EPREG RelatedPerson: Mother) The mother's RelatedPerson resource
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:LocalPid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.telecom:internet.systemrequiredFixed Value: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:internet.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Patient.address.line.extension:addressLine1.value[x]:valueCodeextensibleFixed Value: addressLine1
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:addressLine2.value[x]:valueCodeextensibleFixed Value: addressLine2
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:street.value[x]:valueCodeextensibleFixed Value: street
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:postOfficeBoxText.value[x]:valueCodeextensibleFixed Value: postOfficeBoxText
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.contact:contact.relationshipextensiblePattern Value: contactData
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:nameOfParent.relationshipextensiblePattern Value: PRN
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:emergency.relationshipextensiblePattern Value: C
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:emergency.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.relationshipextensiblePattern Value: GUARD
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:guardian.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard
Patient.link:child.typerequiredPattern Value: seealso
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-addr-1warningPatient.address.country.extension:countrycodeISO 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-pat-1warningPatientIf 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-1-eprerrorPatientAt least one human name shall have a family and a given name.
: name.where(family.exists() and given.exists()).count()>0
ch-pat-2warningPatientgender 'unknown' is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ch-pat-3warningPatient.extension:citizenshipISO 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-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contact, Patient.contact:contact, Patient.contact:nameOfParent, Patient.contact:emergency, Patient.contact:guardianSHALL 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 CHCorePatientEPR

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* CHCorePatientEPR CH EPREG Patient: Mother
... Slices for extension Content/Rules for all slices
.... extension:citizenship 0..* PatCitizenship(5.3.0-ballot-tc1) Nation(s) where the patient claims citizenship
.... extension:pronoun 0..1 (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... Slices for identifier Content/Rules for all slices
.... identifier:AHVN13 0..0 AHVN13Identifier
... name S 1..* CHCoreHumanName A name associated with the patient
.... text S 0..1 string Text representation of the full name
.... family 1..1 string Family name (often called 'Surname')
.... given 1..* string Given names (not always 'first'). Includes middle names
.... 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.
.... telecom:email S 0..* CHCoreContactPointECH46Email A contact detail for the individual
.... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the individual
... birthDate S 1..1 date The date of birth for the individual
... address S 0..* CHCoreAddress An address for the individual
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... postalCode S 0..1 string Postal code for area
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... Slices for contact Content/Rules for all slices
.... contact:emergency S 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:primaryContact 0..1 boolean CH EPREG Extension: Primary Contact
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-primary-contact
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... relationship 1..* CodeableConcept The kind of relationship
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C
..... name S 0..1 HumanName A name associated with the contact person
...... family S 0..1 string Family name (often called 'Surname')
...... given S 0..* string Given names (not always 'first'). Includes middle names
..... Slices for telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... system 1..1 code phone | fax | email | pager | url | sms | other
....... value 1..1 string The actual contact point details
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
.... contact:guardian 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... relationship 1..* CodeableConcept The kind of relationship
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: GUARD
..... name S 0..1 HumanName A name associated with the contact person
...... family S 0..1 string Family name (often called 'Surname')
...... given S 0..* string Given names (not always 'first'). Includes middle names
..... Slices for telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... system 1..1 code phone | fax | email | pager | url | sms | other
....... value 1..1 string The actual contact point details
...... telecom:email 0..* CHCoreContactPointECH46Email A contact detail for the person
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
... Slices for communication Content/Rules for all slices
.... communication:languageOfCorrespondence 0..1 BackboneElement Language of correspondence
... Slices for link 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by value:type
.... link:child 0..* BackboneElement Link to the mother's RelatedPerson resource pointing to the child's Patient resource
..... other 1..1 Reference(CH EPREG RelatedPerson: Mother) The mother's RelatedPerson resource
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
..... type 1..1 code replaced-by | replaces | refer | seealso
Required Pattern: seealso

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* CHCorePatientEPR CH EPREG Patient: Mother
Constraints: ch-pat-1, ch-pat-2, ch-pat-1-epr
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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 C 0..* (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:pronoun 0..1 (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:$this
.... identifier:LocalPid Σ 0..* Identifier Local patient identifier(s)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 0..1 uri The namespace for the identifier value
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:insuranceCardNumber Σ 0..* VEKAIdentifier Insurance card number of the patient (20 digits)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 1..* CHCoreHumanName A name associated with the patient
.... 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 SΣ 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 (extensible)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... given Σ 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 (extensible)
..... 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
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..* CHCoreContactPointECH46Email A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:emailCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory
Binding: eCH-0046 Email Category (extensible)
...... value 0..1 string Primitive value for code
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... telecom:phone SΣ 0..* CHCoreContactPointECH46Phone A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
...... value 0..1 string Primitive value for code
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... telecom:internet Σ 0..* CHCoreContactPointECH46Internet A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:internetCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-internetcategory
Binding: eCH-0046 Internet Category (extensible)
...... value 0..1 string Primitive value for code
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... gender Σ 1..1 code male | female | other | unknown* (* see warning 'ch-pat-2')
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* CHCoreAddress An address for the individual
.... 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 home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: 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
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Ordered, Open by value:url, value:value
...... extension:addressLine1 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine1
...... extension:addressLine2 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine2
...... extension:street 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: street
...... extension:streetName 0..1 string street part of the street line, e.g. withouth housenumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... extension:houseNumber 0..1 string houseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... extension:unitID 0..1 string unitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
...... extension:postOfficeBoxText 0..1 (Complex) Postbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: postOfficeBoxText
...... extension:postOfficeBoxNumber 0..1 string Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... value 0..1 string Primitive value for string
Max Length:1048576
.... 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 Σ 0..1 string Sub-unit of country (abbreviations ok)
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 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:countrycode C 0..1 Coding ISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Binding Description: (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
Constraints: ch-addr-1
..... 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
.... contact:emergency SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:primaryContact 0..1 boolean CH EPREG Extension: Primary Contact
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-primary-contact
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 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/v2-0131
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C
....... 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 S 0..1 HumanName A name associated with the contact person
...... 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 SΣ 0..1 string Family name (often called 'Surname')
...... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... 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
..... Slices for telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
........ value 0..1 string Primitive value for code
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ start ΣC 0..1 dateTime Starting time with inclusive boundary
........ end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
..... 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:guardian C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 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: GUARD
....... 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 S 0..1 HumanName A name associated with the contact person
...... 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 SΣ 0..1 string Family name (often called 'Surname')
...... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... 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
..... Slices for telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
...... telecom:email 0..* CHCoreContactPointECH46Email A contact detail for the person
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:emailCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory
Binding: eCH-0046 Email Category (extensible)
........ value 0..1 string Primitive value for code
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ start ΣC 0..1 dateTime Starting time with inclusive boundary
........ end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
........ value 0..1 string Primitive value for code
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ start ΣC 0..1 dateTime Starting time with inclusive boundary
........ end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
..... address 0..1 Address Address for the contact person
..... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
..... organization C 0..1 Reference(Organization) Organization that is associated with the contact
..... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... Slices for communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Slice: Unordered, Open by value:preferred
.... communication:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... preferred 0..1 boolean Language preference indicator
.... communication:languageOfCorrespondence 0..1 BackboneElement Language of correspondence
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... preferred 1..1 boolean Language preference indicator
Fixed Value: true
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... Slices for link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by value:type
.... link: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
..... 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.
.... link:child ?!Σ 0..* BackboneElement Link to the mother's RelatedPerson resource pointing to the child's Patient resource
..... 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(CH EPREG RelatedPerson: Mother) The mother's RelatedPerson resource
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier:LocalPid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Patient.identifier:LocalPid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.0.1
From the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.telecom:internet.systemrequiredFixed Value: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:internet.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Patient.address.line.extension:addressLine1.value[x]:valueCodeextensibleFixed Value: addressLine1
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:addressLine2.value[x]:valueCodeextensibleFixed Value: addressLine2
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:street.value[x]:valueCodeextensibleFixed Value: street
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:postOfficeBoxText.value[x]:valueCodeextensibleFixed Value: postOfficeBoxText
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.stateexampleECH007CantonAbbreviation
http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation
Patient.maritalStatusextensibleChCoreMaritalStatus
http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.contact:contact.relationshipextensiblePattern Value: contactData
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.contact:nameOfParent.relationshipextensiblePattern Value: PRN
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:nameOfParent.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.contact:emergency.relationshipextensiblePattern Value: C
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:emergency.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:emergency.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.contact:guardian.relationshipextensiblePattern Value: GUARD
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:guardian.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard
Patient.link:child.other.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
Patient.link:child.typerequiredPattern Value: seealso
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-addr-1warningPatient.address.country.extension:countrycodeISO 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-pat-1warningPatientIf 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-1-eprerrorPatientAt least one human name shall have a family and a given name.
: name.where(family.exists() and given.exists()).count()>0
ch-pat-2warningPatientgender 'unknown' is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ch-pat-3warningPatient.extension:citizenshipISO 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-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contact, Patient.contact:contact, Patient.contact:nameOfParent, Patient.contact:emergency, Patient.contact:guardianSHALL 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 CHCorePatientEPR

Summary

Mandatory: 2 elements(7 nested mandatory elements)
Must-Support: 19 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.contact.telecom
  • The element 1 is sliced based on the value of Patient.link

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* CHCorePatientEPR CH EPREG Patient: Mother
Constraints: ch-pat-1, ch-pat-2, ch-pat-1-epr
... 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 C 0..* (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:pronoun 0..1 (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:LocalPid Σ 0..* Identifier Local patient identifier(s)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 0..1 uri The namespace for the identifier value
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:insuranceCardNumber Σ 0..* VEKAIdentifier Insurance card number of the patient (20 digits)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 1..* CHCoreHumanName A name associated with the patient
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full 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 (extensible)
.... given Σ 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 (extensible)
.... 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
..... Slices for extension Content/Rules for all slices
...... 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)
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..* CHCoreContactPointECH46Email A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... Slices for extension Content/Rules for all slices
....... extension:emailCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory
Binding: eCH-0046 Email Category (extensible)
.... telecom:phone SΣ 0..* CHCoreContactPointECH46Phone A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... Slices for extension Content/Rules for all slices
....... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
.... telecom:internet Σ 0..* CHCoreContactPointECH46Internet A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... Slices for extension Content/Rules for all slices
....... extension:internetCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-internetcategory
Binding: eCH-0046 Internet Category (extensible)
... gender Σ 1..1 code male | female | other | unknown* (* see warning 'ch-pat-2')
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* CHCoreAddress An address for the individual
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... Slices for extension Content/Rules for all slices
...... extension:addressLine1 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine1
...... extension:addressLine2 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine2
...... extension:street 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: street
...... extension:streetName 0..1 string street part of the street line, e.g. withouth housenumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... extension:houseNumber 0..1 string houseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... extension:unitID 0..1 string unitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
...... extension:postOfficeBoxText 0..1 (Complex) Postbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: postOfficeBoxText
...... extension:postOfficeBoxNumber 0..1 string Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... 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
.... 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 Content/Rules for all slices
...... extension:countrycode C 0..1 Coding ISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Binding Description: (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
Constraints: ch-addr-1
... 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
.... contact:emergency SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:primaryContact 0..1 boolean CH EPREG Extension: Primary Contact
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-primary-contact
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 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/v2-0131
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C
....... 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 S 0..1 HumanName A name associated with the contact person
...... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
...... family SΣ 0..1 string Family name (often called 'Surname')
...... given SΣ 0..* 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 telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ Slices for extension Content/Rules for all slices
......... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
.... contact:guardian C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 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: GUARD
....... 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 S 0..1 HumanName A name associated with the contact person
...... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
...... family SΣ 0..1 string Family name (often called 'Surname')
...... given SΣ 0..* 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 telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... telecom:email 0..* CHCoreContactPointECH46Email A contact detail for the person
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ Slices for extension Content/Rules for all slices
......... extension:emailCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory
Binding: eCH-0046 Email Category (extensible)
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ Slices for extension Content/Rules for all slices
......... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
... Slices for communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Slice: Unordered, Open by value:preferred
.... communication:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... communication:languageOfCorrespondence 0..1 BackboneElement Language of correspondence
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... preferred 1..1 boolean Language preference indicator
Fixed Value: true
... Slices for link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by value:type
.... link:All Slices Content/Rules for all slices
..... 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.
.... link:child ?!Σ 0..* BackboneElement Link to the mother's RelatedPerson resource pointing to the child's Patient resource
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... other Σ 1..1 Reference(CH EPREG RelatedPerson: Mother) The mother's RelatedPerson resource
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:LocalPid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.telecom:internet.systemrequiredFixed Value: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:internet.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Patient.address.line.extension:addressLine1.value[x]:valueCodeextensibleFixed Value: addressLine1
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:addressLine2.value[x]:valueCodeextensibleFixed Value: addressLine2
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:street.value[x]:valueCodeextensibleFixed Value: street
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:postOfficeBoxText.value[x]:valueCodeextensibleFixed Value: postOfficeBoxText
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.contact:contact.relationshipextensiblePattern Value: contactData
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:nameOfParent.relationshipextensiblePattern Value: PRN
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:emergency.relationshipextensiblePattern Value: C
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:emergency.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.relationshipextensiblePattern Value: GUARD
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:guardian.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard
Patient.link:child.typerequiredPattern Value: seealso
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-addr-1warningPatient.address.country.extension:countrycodeISO 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-pat-1warningPatientIf 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-1-eprerrorPatientAt least one human name shall have a family and a given name.
: name.where(family.exists() and given.exists()).count()>0
ch-pat-2warningPatientgender 'unknown' is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ch-pat-3warningPatient.extension:citizenshipISO 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-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contact, Patient.contact:contact, Patient.contact:nameOfParent, Patient.contact:emergency, Patient.contact:guardianSHALL 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 CHCorePatientEPR

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* CHCorePatientEPR CH EPREG Patient: Mother
... Slices for extension Content/Rules for all slices
.... extension:citizenship 0..* PatCitizenship(5.3.0-ballot-tc1) Nation(s) where the patient claims citizenship
.... extension:pronoun 0..1 (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... Slices for identifier Content/Rules for all slices
.... identifier:AHVN13 0..0 AHVN13Identifier
... name S 1..* CHCoreHumanName A name associated with the patient
.... text S 0..1 string Text representation of the full name
.... family 1..1 string Family name (often called 'Surname')
.... given 1..* string Given names (not always 'first'). Includes middle names
.... 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.
.... telecom:email S 0..* CHCoreContactPointECH46Email A contact detail for the individual
.... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the individual
... birthDate S 1..1 date The date of birth for the individual
... address S 0..* CHCoreAddress An address for the individual
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... postalCode S 0..1 string Postal code for area
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... Slices for contact Content/Rules for all slices
.... contact:emergency S 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:primaryContact 0..1 boolean CH EPREG Extension: Primary Contact
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-primary-contact
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... relationship 1..* CodeableConcept The kind of relationship
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C
..... name S 0..1 HumanName A name associated with the contact person
...... family S 0..1 string Family name (often called 'Surname')
...... given S 0..* string Given names (not always 'first'). Includes middle names
..... Slices for telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... system 1..1 code phone | fax | email | pager | url | sms | other
....... value 1..1 string The actual contact point details
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
.... contact:guardian 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... relationship 1..* CodeableConcept The kind of relationship
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: GUARD
..... name S 0..1 HumanName A name associated with the contact person
...... family S 0..1 string Family name (often called 'Surname')
...... given S 0..* string Given names (not always 'first'). Includes middle names
..... Slices for telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... system 1..1 code phone | fax | email | pager | url | sms | other
....... value 1..1 string The actual contact point details
...... telecom:email 0..* CHCoreContactPointECH46Email A contact detail for the person
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
... Slices for communication Content/Rules for all slices
.... communication:languageOfCorrespondence 0..1 BackboneElement Language of correspondence
... Slices for link 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by value:type
.... link:child 0..* BackboneElement Link to the mother's RelatedPerson resource pointing to the child's Patient resource
..... other 1..1 Reference(CH EPREG RelatedPerson: Mother) The mother's RelatedPerson resource
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
..... type 1..1 code replaced-by | replaces | refer | seealso
Required Pattern: seealso

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* CHCorePatientEPR CH EPREG Patient: Mother
Constraints: ch-pat-1, ch-pat-2, ch-pat-1-epr
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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 C 0..* (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:pronoun 0..1 (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:$this
.... identifier:LocalPid Σ 0..* Identifier Local patient identifier(s)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 0..1 uri The namespace for the identifier value
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:insuranceCardNumber Σ 0..* VEKAIdentifier Insurance card number of the patient (20 digits)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 1..* CHCoreHumanName A name associated with the patient
.... 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 SΣ 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 (extensible)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... given Σ 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 (extensible)
..... 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
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..* CHCoreContactPointECH46Email A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:emailCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory
Binding: eCH-0046 Email Category (extensible)
...... value 0..1 string Primitive value for code
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... telecom:phone SΣ 0..* CHCoreContactPointECH46Phone A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
...... value 0..1 string Primitive value for code
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... telecom:internet Σ 0..* CHCoreContactPointECH46Internet A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:internetCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-internetcategory
Binding: eCH-0046 Internet Category (extensible)
...... value 0..1 string Primitive value for code
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... gender Σ 1..1 code male | female | other | unknown* (* see warning 'ch-pat-2')
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* CHCoreAddress An address for the individual
.... 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 home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: 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
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Ordered, Open by value:url, value:value
...... extension:addressLine1 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine1
...... extension:addressLine2 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine2
...... extension:street 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: street
...... extension:streetName 0..1 string street part of the street line, e.g. withouth housenumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... extension:houseNumber 0..1 string houseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... extension:unitID 0..1 string unitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
...... extension:postOfficeBoxText 0..1 (Complex) Postbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
....... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: postOfficeBoxText
...... extension:postOfficeBoxNumber 0..1 string Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... value 0..1 string Primitive value for string
Max Length:1048576
.... 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 Σ 0..1 string Sub-unit of country (abbreviations ok)
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 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:countrycode C 0..1 Coding ISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Binding Description: (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
Constraints: ch-addr-1
..... 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
.... contact:emergency SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:primaryContact 0..1 boolean CH EPREG Extension: Primary Contact
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-primary-contact
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 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/v2-0131
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C
....... 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 S 0..1 HumanName A name associated with the contact person
...... 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 SΣ 0..1 string Family name (often called 'Surname')
...... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... 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
..... Slices for telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
........ value 0..1 string Primitive value for code
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ start ΣC 0..1 dateTime Starting time with inclusive boundary
........ end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
..... 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:guardian C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:note 0..1 string CH EPREG Extension: Note
URL: http://fhir.ch/ig/ch-epreg/StructureDefinition/ch-epreg-ext-note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 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: GUARD
....... 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 S 0..1 HumanName A name associated with the contact person
...... 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 SΣ 0..1 string Family name (often called 'Surname')
...... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... 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
..... Slices for telecom 0..* ContactPoint A contact detail for the person
Slice: Unordered, Open by value:system
...... telecom:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
...... telecom:email 0..* CHCoreContactPointECH46Email A contact detail for the person
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:emailCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory
Binding: eCH-0046 Email Category (extensible)
........ value 0..1 string Primitive value for code
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ start ΣC 0..1 dateTime Starting time with inclusive boundary
........ end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
...... telecom:phone S 0..* CHCoreContactPointECH46Phone A contact detail for the person
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:phoneCategory 0..1 CodeableConcept Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory
Binding: eCH-0046 Phone Category (extensible)
........ value 0..1 string Primitive value for code
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ start ΣC 0..1 dateTime Starting time with inclusive boundary
........ end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
..... address 0..1 Address Address for the contact person
..... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
..... organization C 0..1 Reference(Organization) Organization that is associated with the contact
..... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... Slices for communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Slice: Unordered, Open by value:preferred
.... communication:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... preferred 0..1 boolean Language preference indicator
.... communication:languageOfCorrespondence 0..1 BackboneElement Language of correspondence
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... preferred 1..1 boolean Language preference indicator
Fixed Value: true
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... Slices for link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by value:type
.... link: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
..... 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.
.... link:child ?!Σ 0..* BackboneElement Link to the mother's RelatedPerson resource pointing to the child's Patient resource
..... 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(CH EPREG RelatedPerson: Mother) The mother's RelatedPerson resource
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier:LocalPid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Patient.identifier:LocalPid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.0.1
From the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.telecom:internet.systemrequiredFixed Value: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.telecom:internet.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Patient.address.line.extension:addressLine1.value[x]:valueCodeextensibleFixed Value: addressLine1
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:addressLine2.value[x]:valueCodeextensibleFixed Value: addressLine2
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:street.value[x]:valueCodeextensibleFixed Value: street
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.line.extension:postOfficeBoxText.value[x]:valueCodeextensibleFixed Value: postOfficeBoxText
http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Patient.address.stateexampleECH007CantonAbbreviation
http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation
Patient.maritalStatusextensibleChCoreMaritalStatus
http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.contact:contact.relationshipextensiblePattern Value: contactData
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.contact:nameOfParent.relationshipextensiblePattern Value: PRN
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:nameOfParent.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.contact:emergency.relationshipextensiblePattern Value: C
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:emergency.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:emergency.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:emergency.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.contact:guardian.relationshipextensiblePattern Value: GUARD
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
From the FHIR Standard
Patient.contact:guardian.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Patient.contact:guardian.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Patient.contact:guardian.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.communication:languageOfCorrespondence.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard
Patient.link:child.other.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
Patient.link:child.typerequiredPattern Value: seealso
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-addr-1warningPatient.address.country.extension:countrycodeISO 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-pat-1warningPatientIf 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-1-eprerrorPatientAt least one human name shall have a family and a given name.
: name.where(family.exists() and given.exists()).count()>0
ch-pat-2warningPatientgender 'unknown' is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ch-pat-3warningPatient.extension:citizenshipISO 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-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contact, Patient.contact:contact, Patient.contact:nameOfParent, Patient.contact:emergency, Patient.contact:guardianSHALL 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 CHCorePatientEPR

Summary

Mandatory: 2 elements(7 nested mandatory elements)
Must-Support: 19 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.contact.telecom
  • The element 1 is sliced based on the value of Patient.link

 

Other representations of profile: CSV, Excel, Schematron