WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build International flag

WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-anc/ and changes regularly. See the Directory of published versions

Resource Profile: WHO Patient

Official URL: http://fhir.org/guides/who/core/StructureDefinition/who-patient Version: 0.3.0
Draft as of 2026-10-16 Computable Name: WHOPatient

WHO Patient

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* CPGPatient Information about an individual or animal receiving health care services
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:religion This element must be supported. 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.Slices for extension.extension:birthPlace This element must be supported. 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:disability This element must be supported. 0..* CodeableConcept Condition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Patient.Slices for extension.extension:nationality This element must be supported. 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime This element must be supported. 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Patient.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. 1..* HumanName A name associated with the patient
Patient.name.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the full name
Patient.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.Slices for extension Content/Rules for all slices
Patient.telecom.Slices for extension.extension:telecom-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.telecom.system This element must be supported. 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.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element must be supported. 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 must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:address-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.address.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.photo This element must be supported. 0..* Attachment Image of the patient
Patient.contact This element must be supported. C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.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.contact.name This element must be supported. 1..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.communication This element must be supported. 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
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 This element must be supported. 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.generalPractitioner This element must be supported. 0..* Reference(WHO Practitioner | WHO PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(WHO Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element must be supported. 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 must be supported. This element is included in summaries. 1..1 Reference(WHO Patient) 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.extension:religion<br/>[CanonicalType[http://hl7.​org/fhir/StructureDefinition/patient-religion]] Base extensible ReligiousAffiliation 📦3.0.0 THO v7.4
Patient.identifier.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.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍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
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 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 CPGPatient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* CPGPatient Information about an individual or animal receiving health care services
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:religion This element must be supported. 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.Slices for extension.extension:birthPlace This element must be supported. 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:disability This element must be supported. 0..* CodeableConcept Condition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Patient.Slices for extension.extension:nationality This element must be supported. 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime This element must be supported. 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.identifier This element must be supported. 1..* Identifier An identifier for this patient
Patient.identifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
Patient.identifier.system This element must be supported. 1..1 uri The namespace for the identifier value
Patient.identifier.value This element must be supported. 1..1 string The value that is unique
Patient.active This element must be supported. 1..1 boolean Whether this patient's record is in active use
Patient.name.use This element must be supported. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Patient.name.text This element must be supported. 1..1 string Text representation of the full name
Patient.telecom This element must be supported. 0..* ContactPoint A contact detail for the individual
Patient.telecom.Slices for extension Content/Rules for all slices
Patient.telecom.Slices for extension.extension:telecom-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.telecom.system This element must be supported. 1..1 code phone | fax | email | pager | url | sms | other
Patient.telecom.value This element must be supported. 1..1 string The actual contact point details
Patient.telecom.use This element must be supported. 1..1 code home | work | temp | old | mobile - purpose of this contact point
Patient.gender This element must be supported. 1..1 code male | female | other | unknown
Patient.birthDate This element must be supported. 0..1 date The date of birth for the individual
Patient.deceased[x] This element must be supported. 0..1 boolean, dateTime Indicates if the individual is deceased or not
Patient.address This element must be supported. 0..* Address An address for the individual
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:address-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.address.use This element must be supported. 1..1 code home | work | temp | old | billing - purpose of this address
Patient.address.text This element must be supported. 1..1 string Text representation of the address
Patient.photo This element must be supported. 0..* Attachment Image of the patient
Patient.contact This element must be supported. 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Patient.contact.name This element must be supported. 1..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.communication This element must be supported. 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Patient.generalPractitioner This element must be supported. 0..* Reference(WHO Practitioner | WHO PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element must be supported. 0..1 Reference(WHO Organization) Organization that is the custodian of the patient record
Patient.link This element must be supported. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.other This element must be supported. 1..1 Reference(WHO Patient) The other patient or related person resource that the link refers to

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:religion<br/>[CanonicalType[http://hl7.​org/fhir/StructureDefinition/patient-religion]] Base extensible ReligiousAffiliation 📦3.0.0 THO v7.4
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* CPGPatient Information about an individual or animal receiving health care services
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:religion This element must be supported. 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.Slices for extension.extension:birthPlace This element must be supported. 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:disability This element must be supported. 0..* CodeableConcept Condition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Patient.Slices for extension.extension:nationality This element must be supported. 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime This element must be supported. 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.id 0..1 string Unique id for inter-element referencing
Patient.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.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.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Patient.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. 1..* HumanName 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 must be supported. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the full name
Patient.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Patient.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
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.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.id 0..1 string Unique id for inter-element referencing
Patient.telecom.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.Slices for extension.extension:telecom-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.telecom.system This element must be supported. 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.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element must be supported. 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 must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.id 0..1 string Unique id for inter-element referencing
Patient.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:address-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.address.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line This element is included in summaries. 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Patient.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Patient.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Patient.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
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 This element must be supported. 0..* Attachment Image of the patient
Patient.contact This element must be supported. C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.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.contact.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.contact.name This element must be supported. 1..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication This element must be supported. 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 This element must be supported. 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 This element must be supported. 0..* Reference(WHO Practitioner | WHO PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(WHO Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element must be supported. 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 must be supported. This element is included in summaries. 1..1 Reference(WHO Patient) 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.extension:religion<br/>[CanonicalType[http://hl7.​org/fhir/StructureDefinition/patient-religion]] Base extensible ReligiousAffiliation 📦3.0.0 THO v7.4
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.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.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
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.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
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 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* CPGPatient Information about an individual or animal receiving health care services
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:religion This element must be supported. 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.Slices for extension.extension:birthPlace This element must be supported. 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:disability This element must be supported. 0..* CodeableConcept Condition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Patient.Slices for extension.extension:nationality This element must be supported. 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime This element must be supported. 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Patient.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. 1..* HumanName A name associated with the patient
Patient.name.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the full name
Patient.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.Slices for extension Content/Rules for all slices
Patient.telecom.Slices for extension.extension:telecom-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.telecom.system This element must be supported. 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.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element must be supported. 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 must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:address-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.address.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.photo This element must be supported. 0..* Attachment Image of the patient
Patient.contact This element must be supported. C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.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.contact.name This element must be supported. 1..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.communication This element must be supported. 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
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 This element must be supported. 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.generalPractitioner This element must be supported. 0..* Reference(WHO Practitioner | WHO PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(WHO Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element must be supported. 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 must be supported. This element is included in summaries. 1..1 Reference(WHO Patient) 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.extension:religion<br/>[CanonicalType[http://hl7.​org/fhir/StructureDefinition/patient-religion]] Base extensible ReligiousAffiliation 📦3.0.0 THO v7.4
Patient.identifier.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.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍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
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 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 CPGPatient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* CPGPatient Information about an individual or animal receiving health care services
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:religion This element must be supported. 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.Slices for extension.extension:birthPlace This element must be supported. 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:disability This element must be supported. 0..* CodeableConcept Condition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Patient.Slices for extension.extension:nationality This element must be supported. 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime This element must be supported. 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.identifier This element must be supported. 1..* Identifier An identifier for this patient
Patient.identifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
Patient.identifier.system This element must be supported. 1..1 uri The namespace for the identifier value
Patient.identifier.value This element must be supported. 1..1 string The value that is unique
Patient.active This element must be supported. 1..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. 1..* HumanName A name associated with the patient
Patient.name.use This element must be supported. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Patient.name.text This element must be supported. 1..1 string Text representation of the full name
Patient.telecom This element must be supported. 0..* ContactPoint A contact detail for the individual
Patient.telecom.Slices for extension Content/Rules for all slices
Patient.telecom.Slices for extension.extension:telecom-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.telecom.system This element must be supported. 1..1 code phone | fax | email | pager | url | sms | other
Patient.telecom.value This element must be supported. 1..1 string The actual contact point details
Patient.telecom.use This element must be supported. 1..1 code home | work | temp | old | mobile - purpose of this contact point
Patient.gender This element must be supported. 1..1 code male | female | other | unknown
Patient.birthDate This element must be supported. 0..1 date The date of birth for the individual
Patient.deceased[x] This element must be supported. 0..1 boolean, dateTime Indicates if the individual is deceased or not
Patient.address This element must be supported. 0..* Address An address for the individual
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:address-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.address.use This element must be supported. 1..1 code home | work | temp | old | billing - purpose of this address
Patient.address.text This element must be supported. 1..1 string Text representation of the address
Patient.photo This element must be supported. 0..* Attachment Image of the patient
Patient.contact This element must be supported. 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Patient.contact.name This element must be supported. 1..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.communication This element must be supported. 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Patient.generalPractitioner This element must be supported. 0..* Reference(WHO Practitioner | WHO PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element must be supported. 0..1 Reference(WHO Organization) Organization that is the custodian of the patient record
Patient.link This element must be supported. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.other This element must be supported. 1..1 Reference(WHO Patient) The other patient or related person resource that the link refers to

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:religion<br/>[CanonicalType[http://hl7.​org/fhir/StructureDefinition/patient-religion]] Base extensible ReligiousAffiliation 📦3.0.0 THO v7.4

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* CPGPatient Information about an individual or animal receiving health care services
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:religion This element must be supported. 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
Patient.Slices for extension.extension:birthPlace This element must be supported. 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:disability This element must be supported. 0..* CodeableConcept Condition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Patient.Slices for extension.extension:nationality This element must be supported. 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime This element must be supported. 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.id 0..1 string Unique id for inter-element referencing
Patient.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.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.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Patient.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. 1..* HumanName 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 must be supported. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the full name
Patient.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Patient.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
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.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.id 0..1 string Unique id for inter-element referencing
Patient.telecom.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.Slices for extension.extension:telecom-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.telecom.system This element must be supported. 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.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element must be supported. 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 must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.id 0..1 string Unique id for inter-element referencing
Patient.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:address-preferred This element must be supported. 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.address.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line This element is included in summaries. 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Patient.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Patient.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Patient.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
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 This element must be supported. 0..* Attachment Image of the patient
Patient.contact This element must be supported. C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.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.contact.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.contact.name This element must be supported. 1..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication This element must be supported. 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 This element must be supported. 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 This element must be supported. 0..* Reference(WHO Practitioner | WHO PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(WHO Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element must be supported. 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 must be supported. This element is included in summaries. 1..1 Reference(WHO Patient) 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.extension:religion<br/>[CanonicalType[http://hl7.​org/fhir/StructureDefinition/patient-religion]] Base extensible ReligiousAffiliation 📦3.0.0 THO v7.4
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.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.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
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.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
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 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()

 

Other representations of profile: CSV, Excel, Schematron