Enterprise Imaging (Proof of Concept)
0.1.0 - proof-of-concept United Kingdom flag

Enterprise Imaging (Proof of Concept) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Patient

Official URL: https://fhir.nwgenomics.nhs.uk/Imaging/StructureDefinition/Patient Version: 0.1.0
Draft as of 2026-11-01 Computable Name: Patient

Patient Administration HL7 Europe Core - Patient. Copied from the NW GMSA FHIR IG.

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 0..* PatientEuCore 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:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 AddressEu 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 Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
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. 1..* CorrelationIdentifier Patient identifiers
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.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:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Patient.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri Recommended. This may be defined by a EPR/LIMS system.
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string The value MUST be unique to the organisation
Example General: 123456
Patient.Slices for identifier.identifier:All Slices.assigner This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Assigning Facility
Patient.Slices for identifier.identifier:All Slices.assigner.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.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:All Slices.assigner.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed)
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
Patient.Slices for identifier.identifier:MedicalRecordNumber This element must be supported. This element is included in summaries. 0..* MedicalRecordNumber Medical Record Number
Patient.Slices for identifier.identifier:nhsNumber This element must be supported. This element is included in summaries. 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
Patient.Slices for identifier.identifier:PatientIdentifier This element is included in summaries. 0..* PatientIdentifier Patient Identifier
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 must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: eu-pat-1
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.gender This element must be supported. This element is included in summaries. 0..1 code Administrative Gender
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. 1..1 date The date of birth for the patient
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.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.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base required NW IdentifierType 📦0.1.0 This IG
Patient.identifier.assigner.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍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())
eu-pat-1 error Patient.name given, family, text or a data-absent-reason extension SHALL be present family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from PatientEuCore

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* PatientEuCore Information about an individual or animal receiving health care services
Patient.Slices for identifier 1..* CorrelationIdentifier Patient identifiers
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.assigner 0..1 Reference(Organization) Assigning Facility
Patient.Slices for identifier.identifier:MedicalRecordNumber This element must be supported. 0..* MedicalRecordNumber Medical Record Number
Patient.Slices for identifier.identifier:nhsNumber This element must be supported. 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
Patient.Slices for identifier.identifier:PatientIdentifier 0..* PatientIdentifier Patient Identifier
Patient.name This element must be supported. 1..* HumanName A name associated with the patient
Patient.gender This element must be supported. 0..1 code Administrative Gender
Patient.address
Patient.address.postalCode 1..1 string Postal code

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* PatientEuCore 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:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.id 0..1 id Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 AddressEu 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 Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
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. 1..* CorrelationIdentifier Patient identifiers
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.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:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Patient.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri Recommended. This may be defined by a EPR/LIMS system.
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string The value MUST be unique to the organisation
Example General: 123456
Patient.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Assigning Facility
Patient.Slices for identifier.identifier:All Slices.assigner.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.assigner.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Patient.Slices for identifier.identifier:All Slices.assigner.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Patient.Slices for identifier.identifier:All Slices.assigner.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.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:All Slices.assigner.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.Slices for identifier.identifier:All Slices.assigner.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed)
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:All Slices.assigner.display This element is included in summaries. 0..1 string Text alternative for the resource
Patient.Slices for identifier.identifier:MedicalRecordNumber This element must be supported. This element is included in summaries. 0..* MedicalRecordNumber Medical Record Number
Patient.Slices for identifier.identifier:nhsNumber This element must be supported. This element is included in summaries. 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
Patient.Slices for identifier.identifier:PatientIdentifier This element is included in summaries. 0..* PatientIdentifier Patient Identifier
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 must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: eu-pat-1
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 Family name.
Example spanish: Valero Iglesias
Patient.name.given This element is included in summaries. 0..* string Given names. 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 is included in summaries. 0..* ContactPoint A contact detail for the patient
Patient.gender This element must be supported. This element is included in summaries. 0..1 code Administrative Gender
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. 1..1 date The date of birth for the patient
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..* AddressEu 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.address.id 0..1 string Unique id for inter-element referencing
Patient.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code 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 Address type (postal | physical)
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element is included in summaries. 0..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.line.id 0..1 string xml:id (or equivalent in JSON)
Patient.address.line.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.address.line.Slices for extension.extension:streetName 0..* string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Patient.address.line.Slices for extension.extension:houseNumber 0..* string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Patient.address.line.Slices for extension.extension:postBox 0..* string postBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Patient.address.line.value 0..1 string Primitive value for string
Max Length:1048576
Patient.address.city This element is included in summaries. 0..1 string City
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. 1..1 string Postal code
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.country.id 0..1 string xml:id (or equivalent in JSON)
Patient.address.country.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.address.country.Slices for extension.extension:countryCode 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Patient.address.country.Slices for extension.extension:countryCode.id 0..1 id Unique id for inter-element referencing
Patient.address.country.Slices for extension.extension:countryCode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.address.country.Slices for extension.extension:countryCode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
Patient.address.country.Slices for extension.extension:countryCode.value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)
Patient.address.country.value 0..1 string Primitive value for string
Max Length:1048576
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 status
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 0..* Attachment Image of the patient
Patient.contact 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 Contact relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName Contact name
Patient.contact.telecom 0..* ContactPoint Contact details for the person
Patient.contact.address 0..1 AddressEu 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 Contact person address
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 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 Communication language
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.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base required NW IdentifierType 📦0.1.0 This IG
Patient.identifier.assigner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Patient.identifier.assigner.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.assigner.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍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.address.country.​extension:countryCode.​value[x] Base preferred Iso 3166 Part 1: 2 Letter Codes 📦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())
eu-pat-1 error Patient.name given, family, text or a data-absent-reason extension SHALL be present family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
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 PatientEuCore

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* PatientEuCore 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:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 AddressEu 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 Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
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. 1..* CorrelationIdentifier Patient identifiers
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.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:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Patient.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri Recommended. This may be defined by a EPR/LIMS system.
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string The value MUST be unique to the organisation
Example General: 123456
Patient.Slices for identifier.identifier:All Slices.assigner This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Assigning Facility
Patient.Slices for identifier.identifier:All Slices.assigner.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.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:All Slices.assigner.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed)
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
Patient.Slices for identifier.identifier:MedicalRecordNumber This element must be supported. This element is included in summaries. 0..* MedicalRecordNumber Medical Record Number
Patient.Slices for identifier.identifier:nhsNumber This element must be supported. This element is included in summaries. 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
Patient.Slices for identifier.identifier:PatientIdentifier This element is included in summaries. 0..* PatientIdentifier Patient Identifier
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 must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: eu-pat-1
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.gender This element must be supported. This element is included in summaries. 0..1 code Administrative Gender
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. 1..1 date The date of birth for the patient
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.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.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base required NW IdentifierType 📦0.1.0 This IG
Patient.identifier.assigner.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍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())
eu-pat-1 error Patient.name given, family, text or a data-absent-reason extension SHALL be present family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from PatientEuCore

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* PatientEuCore Information about an individual or animal receiving health care services
Patient.Slices for identifier 1..* CorrelationIdentifier Patient identifiers
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.assigner 0..1 Reference(Organization) Assigning Facility
Patient.Slices for identifier.identifier:MedicalRecordNumber This element must be supported. 0..* MedicalRecordNumber Medical Record Number
Patient.Slices for identifier.identifier:nhsNumber This element must be supported. 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
Patient.Slices for identifier.identifier:PatientIdentifier 0..* PatientIdentifier Patient Identifier
Patient.name This element must be supported. 1..* HumanName A name associated with the patient
Patient.gender This element must be supported. 0..1 code Administrative Gender
Patient.birthDate This element must be supported. 1..1 date The date of birth for the patient
Patient.address
Patient.address.postalCode 1..1 string Postal code

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* PatientEuCore 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:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.id 0..1 id Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 AddressEu 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 Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
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. 1..* CorrelationIdentifier Patient identifiers
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.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:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Patient.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri Recommended. This may be defined by a EPR/LIMS system.
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string The value MUST be unique to the organisation
Example General: 123456
Patient.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Assigning Facility
Patient.Slices for identifier.identifier:All Slices.assigner.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.assigner.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Patient.Slices for identifier.identifier:All Slices.assigner.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Patient.Slices for identifier.identifier:All Slices.assigner.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.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:All Slices.assigner.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.Slices for identifier.identifier:All Slices.assigner.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed)
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:All Slices.assigner.display This element is included in summaries. 0..1 string Text alternative for the resource
Patient.Slices for identifier.identifier:MedicalRecordNumber This element must be supported. This element is included in summaries. 0..* MedicalRecordNumber Medical Record Number
Patient.Slices for identifier.identifier:nhsNumber This element must be supported. This element is included in summaries. 0..* NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
Patient.Slices for identifier.identifier:PatientIdentifier This element is included in summaries. 0..* PatientIdentifier Patient Identifier
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 must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: eu-pat-1
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 Family name.
Example spanish: Valero Iglesias
Patient.name.given This element is included in summaries. 0..* string Given names. 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 is included in summaries. 0..* ContactPoint A contact detail for the patient
Patient.gender This element must be supported. This element is included in summaries. 0..1 code Administrative Gender
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. 1..1 date The date of birth for the patient
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..* AddressEu 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.address.id 0..1 string Unique id for inter-element referencing
Patient.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code 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 Address type (postal | physical)
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element is included in summaries. 0..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.line.id 0..1 string xml:id (or equivalent in JSON)
Patient.address.line.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.address.line.Slices for extension.extension:streetName 0..* string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Patient.address.line.Slices for extension.extension:houseNumber 0..* string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Patient.address.line.Slices for extension.extension:postBox 0..* string postBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Patient.address.line.value 0..1 string Primitive value for string
Max Length:1048576
Patient.address.city This element is included in summaries. 0..1 string City
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. 1..1 string Postal code
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.country.id 0..1 string xml:id (or equivalent in JSON)
Patient.address.country.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.address.country.Slices for extension.extension:countryCode 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Patient.address.country.Slices for extension.extension:countryCode.id 0..1 id Unique id for inter-element referencing
Patient.address.country.Slices for extension.extension:countryCode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.address.country.Slices for extension.extension:countryCode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
Patient.address.country.Slices for extension.extension:countryCode.value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)
Patient.address.country.value 0..1 string Primitive value for string
Max Length:1048576
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 status
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 0..* Attachment Image of the patient
Patient.contact 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 Contact relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName Contact name
Patient.contact.telecom 0..* ContactPoint Contact details for the person
Patient.contact.address 0..1 AddressEu 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 Contact person address
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 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 Communication language
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.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base required NW IdentifierType 📦0.1.0 This IG
Patient.identifier.assigner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Patient.identifier.assigner.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.assigner.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍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.address.country.​extension:countryCode.​value[x] Base preferred Iso 3166 Part 1: 2 Letter Codes 📦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())
eu-pat-1 error Patient.name given, family, text or a data-absent-reason extension SHALL be present family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
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 PatientEuCore

 

Other representations of profile: CSV, Excel, Schematron