CH ALIS Connect (R4)
1.0.0-ballot - ballot Switzerland flag

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

Resource Profile: CH ALIS Patient Profile

Official URL: http://fhir.ch/ig/ch-alis-connect/StructureDefinition/ch-alis-connect-patient Version: 1.0.0-ballot
Active as of 2026-10-17 Computable Name: ChAlisPatient

Copyright/Legal: CC0-1.0

Base definition for the Patient resource in the context of ALIS-Connect.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* CHCorePatient CH ALIS Patient
Constraints: ch-pat-1, ch-pat-2
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 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
Patient.Slices for extension.extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
Patient.Slices for extension.extension:citizenship C 0..* (Complex) Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:$this
Patient.Slices for identifier.identifier:EPR-SPID This element is included in summaries. 0..* EPRSPIDIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well EPR-SPID

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.30.1.127.3.10.3"
}
Patient.Slices for identifier.identifier:AHVN13 This element is included in summaries. 0..* AHVN13Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points)

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.32"
}
Patient.Slices for identifier.identifier:LocalPid This element is included in summaries. 0..1 Identifier Local patient identifier(s)

Required Pattern:
{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}
Patient.Slices for identifier.identifier:LocalPid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:LocalPid.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string PatientID
Example General: 123456
Patient.Slices for identifier.identifier:insuranceCardNumber This element is included in summaries. 0..* VEKAIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Insurance card number of the patient (20 digits)

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.30.1.123.100.1.1.1"
}
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 0..1 CHCoreHumanName The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A name associated with the patient
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element is included in summaries. 0..1 string PatientName
Patient.name.family.Slices for extension Content/Rules for all slices
Patient.name.family.Slices for extension.extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
Patient.name.given This element is included in summaries. 0..1 string PatientGivenName
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.given.Slices for extension Content/Rules for all slices
Patient.name.given.Slices for extension.extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
Patient.Slices for telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:All Slices Content/Rules for all slices
Patient.Slices for telecom.telecom:All Slices.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.Slices for telecom.telecom:All Slices.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:email This element is included in summaries. 0..* CHCoreContactPointECH46Email The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:email.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Patient.Slices for telecom.telecom:email.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:email.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:email.use.Slices for extension.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)
Patient.Slices for telecom.telecom:phone This element is included in summaries. 0..* CHCoreContactPointECH46Phone The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:phone.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Patient.Slices for telecom.telecom:phone.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:phone.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:phone.use.Slices for extension.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)
Patient.Slices for telecom.telecom:internet This element is included in summaries. 0..* CHCoreContactPointECH46Internet The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:internet.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url (no extensions allowed)
Patient.Slices for telecom.telecom:internet.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:internet.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:internet.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:internet.use.Slices for extension.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)
Patient.gender This element is included in summaries. 0..1 code PatientGender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 0..1 date PatientBirthDate
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
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
Patient.Slices for contact.contact:All Slices Content/Rules for all slices
Patient.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact C 0..1 BackboneElement Contact data if it is not the address of the patient
Constraints: pat-1
Patient.Slices for contact.contact:contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact.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:
{
  "coding" : [
    {
      "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
      "code" : "contactData"
    }
  ]
}
Patient.Slices for contact.contact:contact.address 1..1 CHCoreAddressECH10 The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address for the contact person
Patient.Slices for contact.contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
Patient.Slices for contact.contact:nameOfParent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:nameOfParent.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:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "PRN"
    }
  ]
}
Patient.Slices for contact.contact:nameOfParent.name 1..1 HumanName A name associated with the contact person
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2 warning Patient gender 'unknown' is currently not used in Switzerland in eCH and the EPR gender.empty() or gender!='unknown'
ch-pat-3 warning Patient.extension:citizenship ISO Country Alpha-2 or ISO Country Alpha-3 code ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from CHCorePatient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* CHCorePatient CH ALIS Patient
Patient.Slices for identifier Content/Rules for all slices
Patient.Slices for identifier.identifier:LocalPid 0..1 Identifier Local patient identifier(s)
Patient.Slices for identifier.identifier:LocalPid.value 1..1 string PatientID
Patient.name 0..1 CHCoreHumanName A name associated with the patient
Patient.name.family 0..1 string PatientName
Patient.name.given 0..1 string PatientGivenName
Patient.gender 0..1 code PatientGender

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* CHCorePatient CH ALIS Patient
Constraints: ch-pat-1, ch-pat-2
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.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
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 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
Patient.Slices for extension.extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
Patient.Slices for extension.extension:citizenship C 0..* (Complex) Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:$this
Patient.Slices for identifier.identifier:EPR-SPID This element is included in summaries. 0..* EPRSPIDIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well EPR-SPID

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.30.1.127.3.10.3"
}
Patient.Slices for identifier.identifier:AHVN13 This element is included in summaries. 0..* AHVN13Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points)

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.32"
}
Patient.Slices for identifier.identifier:LocalPid This element is included in summaries. 0..1 Identifier Local patient identifier(s)

Required Pattern:
{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}
Patient.Slices for identifier.identifier:LocalPid.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:LocalPid.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:LocalPid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:LocalPid.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:LocalPid.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string PatientID
Example General: 123456
Patient.Slices for identifier.identifier:LocalPid.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:LocalPid.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:insuranceCardNumber This element is included in summaries. 0..* VEKAIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Insurance card number of the patient (20 digits)

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.30.1.123.100.1.1.1"
}
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 0..1 CHCoreHumanName The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A name associated with the patient
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element is included in summaries. 0..1 string PatientName
Patient.name.family.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.family.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.name.family.Slices for extension.extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
Patient.name.family.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.given This element is included in summaries. 0..1 string PatientGivenName
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.given.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.given.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.name.given.Slices for extension.extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
Patient.name.given.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.prefix This element is included in summaries. 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
Patient.name.prefix.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.prefix.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.name.prefix.Slices for extension.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)
Patient.name.prefix.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.Slices for telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:All Slices Content/Rules for all slices
Patient.Slices for telecom.telecom:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:All Slices.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.Slices for telecom.telecom:All Slices.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:All Slices.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.Slices for telecom.telecom:All Slices.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.Slices for telecom.telecom:email This element is included in summaries. 0..* CHCoreContactPointECH46Email The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:email.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:email.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:email.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Patient.Slices for telecom.telecom:email.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:email.use.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for telecom.telecom:email.use.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:email.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:email.use.Slices for extension.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)
Patient.Slices for telecom.telecom:email.use.value 0..1 string Primitive value for code
Patient.Slices for telecom.telecom:email.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.Slices for telecom.telecom:email.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.Slices for telecom.telecom:email.period.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:email.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:email.period.start This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Patient.Slices for telecom.telecom:email.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Patient.Slices for telecom.telecom:phone This element is included in summaries. 0..* CHCoreContactPointECH46Phone The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:phone.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:phone.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:phone.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Patient.Slices for telecom.telecom:phone.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:phone.use.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for telecom.telecom:phone.use.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:phone.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:phone.use.Slices for extension.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)
Patient.Slices for telecom.telecom:phone.use.value 0..1 string Primitive value for code
Patient.Slices for telecom.telecom:phone.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.Slices for telecom.telecom:phone.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.Slices for telecom.telecom:phone.period.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:phone.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:phone.period.start This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Patient.Slices for telecom.telecom:phone.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Patient.Slices for telecom.telecom:internet This element is included in summaries. 0..* CHCoreContactPointECH46Internet The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:internet.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:internet.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:internet.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url (no extensions allowed)
Patient.Slices for telecom.telecom:internet.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:internet.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:internet.use.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for telecom.telecom:internet.use.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:internet.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:internet.use.Slices for extension.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)
Patient.Slices for telecom.telecom:internet.use.value 0..1 string Primitive value for code
Patient.Slices for telecom.telecom:internet.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.Slices for telecom.telecom:internet.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.Slices for telecom.telecom:internet.period.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:internet.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:internet.period.start This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Patient.Slices for telecom.telecom:internet.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Patient.gender This element is included in summaries. 0..1 code PatientGender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 0..1 date PatientBirthDate
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element is included in summaries. 0..* CHCoreAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)
Patient.maritalStatus.id 0..1 string Unique id for inter-element referencing
Patient.maritalStatus.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.maritalStatus.Slices for extension.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
Patient.maritalStatus.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.maritalStatus.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
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
Patient.Slices for contact.contact:All Slices Content/Rules for all slices
Patient.Slices for contact.contact:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:All Slices.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:All Slices.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.
Patient.Slices for contact.contact:All Slices.name 0..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:All Slices.telecom 0..* ContactPoint A contact detail for the person
Patient.Slices for contact.contact:All Slices.address 0..1 Address Address for the contact person
Patient.Slices for contact.contact:All Slices.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:All Slices.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:All Slices.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.Slices for contact.contact:contact C 0..1 BackboneElement Contact data if it is not the address of the patient
Constraints: pat-1
Patient.Slices for contact.contact:contact.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:contact.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact.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:
{
  "coding" : [
    {
      "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
      "code" : "contactData"
    }
  ]
}
Patient.Slices for contact.contact:contact.name 0..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:contact.address 1..1 CHCoreAddressECH10 The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address for the contact person
Patient.Slices for contact.contact:contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.Slices for contact.contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
Patient.Slices for contact.contact:nameOfParent.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:nameOfParent.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:nameOfParent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:nameOfParent.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:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "PRN"
    }
  ]
}
Patient.Slices for contact.contact:nameOfParent.name 1..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:nameOfParent.telecom 0..* ContactPoint A contact detail for the person
Patient.Slices for contact.contact:nameOfParent.address 0..1 Address Address for the contact person
Patient.Slices for contact.contact:nameOfParent.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:nameOfParent.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:nameOfParent.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.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
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:LocalPid.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible ChCoreMaritalStatus 📦3.4.0 CH Term v3.4
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:contact.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2 warning Patient gender 'unknown' is currently not used in Switzerland in eCH and the EPR gender.empty() or gender!='unknown'
ch-pat-3 warning Patient.extension:citizenship ISO Country Alpha-2 or ISO Country Alpha-3 code ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from CHCorePatient

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* CHCorePatient CH ALIS Patient
Constraints: ch-pat-1, ch-pat-2
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 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
Patient.Slices for extension.extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
Patient.Slices for extension.extension:citizenship C 0..* (Complex) Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:$this
Patient.Slices for identifier.identifier:EPR-SPID This element is included in summaries. 0..* EPRSPIDIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well EPR-SPID

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.30.1.127.3.10.3"
}
Patient.Slices for identifier.identifier:AHVN13 This element is included in summaries. 0..* AHVN13Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points)

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.32"
}
Patient.Slices for identifier.identifier:LocalPid This element is included in summaries. 0..1 Identifier Local patient identifier(s)

Required Pattern:
{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}
Patient.Slices for identifier.identifier:LocalPid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:LocalPid.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string PatientID
Example General: 123456
Patient.Slices for identifier.identifier:insuranceCardNumber This element is included in summaries. 0..* VEKAIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Insurance card number of the patient (20 digits)

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.30.1.123.100.1.1.1"
}
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 0..1 CHCoreHumanName The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A name associated with the patient
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element is included in summaries. 0..1 string PatientName
Patient.name.family.Slices for extension Content/Rules for all slices
Patient.name.family.Slices for extension.extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
Patient.name.given This element is included in summaries. 0..1 string PatientGivenName
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.given.Slices for extension Content/Rules for all slices
Patient.name.given.Slices for extension.extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
Patient.Slices for telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:All Slices Content/Rules for all slices
Patient.Slices for telecom.telecom:All Slices.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.Slices for telecom.telecom:All Slices.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:email This element is included in summaries. 0..* CHCoreContactPointECH46Email The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:email.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Patient.Slices for telecom.telecom:email.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:email.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:email.use.Slices for extension.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)
Patient.Slices for telecom.telecom:phone This element is included in summaries. 0..* CHCoreContactPointECH46Phone The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:phone.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Patient.Slices for telecom.telecom:phone.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:phone.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:phone.use.Slices for extension.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)
Patient.Slices for telecom.telecom:internet This element is included in summaries. 0..* CHCoreContactPointECH46Internet The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:internet.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url (no extensions allowed)
Patient.Slices for telecom.telecom:internet.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:internet.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:internet.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:internet.use.Slices for extension.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)
Patient.gender This element is included in summaries. 0..1 code PatientGender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 0..1 date PatientBirthDate
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
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
Patient.Slices for contact.contact:All Slices Content/Rules for all slices
Patient.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact C 0..1 BackboneElement Contact data if it is not the address of the patient
Constraints: pat-1
Patient.Slices for contact.contact:contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact.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:
{
  "coding" : [
    {
      "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
      "code" : "contactData"
    }
  ]
}
Patient.Slices for contact.contact:contact.address 1..1 CHCoreAddressECH10 The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address for the contact person
Patient.Slices for contact.contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
Patient.Slices for contact.contact:nameOfParent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:nameOfParent.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:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "PRN"
    }
  ]
}
Patient.Slices for contact.contact:nameOfParent.name 1..1 HumanName A name associated with the contact person
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2 warning Patient gender 'unknown' is currently not used in Switzerland in eCH and the EPR gender.empty() or gender!='unknown'
ch-pat-3 warning Patient.extension:citizenship ISO Country Alpha-2 or ISO Country Alpha-3 code ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

Differential View

This structure is derived from CHCorePatient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* CHCorePatient CH ALIS Patient
Patient.Slices for identifier Content/Rules for all slices
Patient.Slices for identifier.identifier:LocalPid 0..1 Identifier Local patient identifier(s)
Patient.Slices for identifier.identifier:LocalPid.value 1..1 string PatientID
Patient.name 0..1 CHCoreHumanName A name associated with the patient
Patient.name.family 0..1 string PatientName
Patient.name.given 0..1 string PatientGivenName
Patient.gender 0..1 code PatientGender
Patient.birthDate 0..1 date PatientBirthDate

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* CHCorePatient CH ALIS Patient
Constraints: ch-pat-1, ch-pat-2
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.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
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:placeOfBirth 0..1 CHCoreAddressEch11PlaceOfBirth The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 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
Patient.Slices for extension.extension:placeOfOrigin 0..* CHCoreAddressECH11PlaceOfOrigin The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Place of origin(s) of the patient
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-ech-11-placeoforigin
Patient.Slices for extension.extension:citizenship C 0..* (Complex) Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Constraints: ch-pat-3
Patient.Slices for extension.extension:religion 0..1 CodeableConcept Religion of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:$this
Patient.Slices for identifier.identifier:EPR-SPID This element is included in summaries. 0..* EPRSPIDIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well EPR-SPID

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.30.1.127.3.10.3"
}
Patient.Slices for identifier.identifier:AHVN13 This element is included in summaries. 0..* AHVN13Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points)

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.32"
}
Patient.Slices for identifier.identifier:LocalPid This element is included in summaries. 0..1 Identifier Local patient identifier(s)

Required Pattern:
{
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MR"
      }
    ]
  }
}
Patient.Slices for identifier.identifier:LocalPid.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:LocalPid.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:LocalPid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:LocalPid.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:LocalPid.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:LocalPid.value This element is included in summaries. 1..1 string PatientID
Example General: 123456
Patient.Slices for identifier.identifier:LocalPid.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:LocalPid.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:insuranceCardNumber This element is included in summaries. 0..* VEKAIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Insurance card number of the patient (20 digits)

Required Pattern:
{
  "system" : "urn:oid:2.16.756.5.30.1.123.100.1.1.1"
}
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 0..1 CHCoreHumanName The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A name associated with the patient
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element is included in summaries. 0..1 string PatientName
Patient.name.family.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.family.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.name.family.Slices for extension.extension:ech11name 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required)
Patient.name.family.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.given This element is included in summaries. 0..1 string PatientGivenName
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.given.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.given.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.name.given.Slices for extension.extension:ech11firstname 0..1 code Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
Binding: eCH-011 FirstNameDataTypes (required)
Patient.name.given.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.prefix This element is included in summaries. 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
Patient.name.prefix.id 0..1 string xml:id (or equivalent in JSON)
Patient.name.prefix.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.name.prefix.Slices for extension.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)
Patient.name.prefix.value 0..1 string Primitive value for string
Max Length:1048576
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.Slices for telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:All Slices Content/Rules for all slices
Patient.Slices for telecom.telecom:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:All Slices.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.Slices for telecom.telecom:All Slices.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:All Slices.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.Slices for telecom.telecom:All Slices.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.Slices for telecom.telecom:email This element is included in summaries. 0..* CHCoreContactPointECH46Email The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:email.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:email.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:email.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Patient.Slices for telecom.telecom:email.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:email.use.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for telecom.telecom:email.use.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:email.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:email.use.Slices for extension.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)
Patient.Slices for telecom.telecom:email.use.value 0..1 string Primitive value for code
Patient.Slices for telecom.telecom:email.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.Slices for telecom.telecom:email.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.Slices for telecom.telecom:email.period.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:email.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:email.period.start This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Patient.Slices for telecom.telecom:email.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Patient.Slices for telecom.telecom:phone This element is included in summaries. 0..* CHCoreContactPointECH46Phone The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:phone.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:phone.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:phone.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Patient.Slices for telecom.telecom:phone.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:phone.use.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for telecom.telecom:phone.use.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:phone.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:phone.use.Slices for extension.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)
Patient.Slices for telecom.telecom:phone.use.value 0..1 string Primitive value for code
Patient.Slices for telecom.telecom:phone.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.Slices for telecom.telecom:phone.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.Slices for telecom.telecom:phone.period.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:phone.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:phone.period.start This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Patient.Slices for telecom.telecom:phone.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Patient.Slices for telecom.telecom:internet This element is included in summaries. 0..* CHCoreContactPointECH46Internet The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A contact detail for the individual
Patient.Slices for telecom.telecom:internet.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:internet.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:internet.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url (no extensions allowed)
Patient.Slices for telecom.telecom:internet.value This element is included in summaries. 1..1 string The actual contact point details
Patient.Slices for telecom.telecom:internet.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:internet.use.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for telecom.telecom:internet.use.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:internet.use.Slices for extension Content/Rules for all slices
Patient.Slices for telecom.telecom:internet.use.Slices for extension.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)
Patient.Slices for telecom.telecom:internet.use.value 0..1 string Primitive value for code
Patient.Slices for telecom.telecom:internet.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.Slices for telecom.telecom:internet.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.Slices for telecom.telecom:internet.period.id 0..1 string Unique id for inter-element referencing
Patient.Slices for telecom.telecom:internet.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:internet.period.start This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Patient.Slices for telecom.telecom:internet.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Patient.gender This element is included in summaries. 0..1 code PatientGender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 0..1 date PatientBirthDate
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element is included in summaries. 0..* CHCoreAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (extensible)
Patient.maritalStatus.id 0..1 string Unique id for inter-element referencing
Patient.maritalStatus.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.maritalStatus.Slices for extension.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
Patient.maritalStatus.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.maritalStatus.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
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
Patient.Slices for contact.contact:All Slices Content/Rules for all slices
Patient.Slices for contact.contact:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:All Slices.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:All Slices.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.
Patient.Slices for contact.contact:All Slices.name 0..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:All Slices.telecom 0..* ContactPoint A contact detail for the person
Patient.Slices for contact.contact:All Slices.address 0..1 Address Address for the contact person
Patient.Slices for contact.contact:All Slices.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:All Slices.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:All Slices.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.Slices for contact.contact:contact C 0..1 BackboneElement Contact data if it is not the address of the patient
Constraints: pat-1
Patient.Slices for contact.contact:contact.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:contact.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:contact.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:
{
  "coding" : [
    {
      "system" : "http://fhir.ch/ig/ch-core/CodeSystem/ech-11",
      "code" : "contactData"
    }
  ]
}
Patient.Slices for contact.contact:contact.name 0..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:contact.address 1..1 CHCoreAddressECH10 The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address for the contact person
Patient.Slices for contact.contact:contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.Slices for contact.contact:nameOfParent C 0..* BackboneElement Name of parent
Constraints: pat-1
Patient.Slices for contact.contact:nameOfParent.id 0..1 string Unique id for inter-element referencing
Patient.Slices for contact.contact:nameOfParent.extension 0..* Extension Additional content defined by implementations
Patient.Slices for contact.contact:nameOfParent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for contact.contact:nameOfParent.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:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "PRN"
    }
  ]
}
Patient.Slices for contact.contact:nameOfParent.name 1..1 HumanName A name associated with the contact person
Patient.Slices for contact.contact:nameOfParent.telecom 0..* ContactPoint A contact detail for the person
Patient.Slices for contact.contact:nameOfParent.address 0..1 Address Address for the contact person
Patient.Slices for contact.contact:nameOfParent.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.Slices for contact.contact:nameOfParent.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.Slices for contact.contact:nameOfParent.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.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
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier:LocalPid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:LocalPid.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:internet.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:internet.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible ChCoreMaritalStatus 📦3.4.0 CH Term v3.4
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:contact.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:contact.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact:nameOfParent.​gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-pat-1 warning Patient If one ore more human names are provided, at least one human name should have a family and a given name. name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2 warning Patient gender 'unknown' is currently not used in Switzerland in eCH and the EPR gender.empty() or gender!='unknown'
ch-pat-3 warning Patient.extension:citizenship ISO Country Alpha-2 or ISO Country Alpha-3 code ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact, Patient.contact:contact, Patient.contact:nameOfParent SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from CHCorePatient

Summary

 

Other representations of profile: CSV, Excel, Schematron