International Patient Summary Implementation Guide
2.0.0 -

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions

## Resource Profile: Patient (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips | Version: 2.0.0
Standards status: Trial-use Active as of 2024-06-19 | Maturity Level: 3 | Computable Name: PatientUvIps

This profile represents the constraints applied to the Patient resource by the International Patient Summary (IPS) FHIR Implementation Guide and describes the minimum expectations for the Patient resource when used in the IPS composition or in one of the referred resources.

This profile generally seeks to align with guidance from the HL7 Cross Paradigm Implementation Guide: Gender Harmony - Sex and Gender Representation. While the extensions of Individual Gender Identity and Individual Pronouns are not flagged as MustSupport in IPS, we recommend implementers consult with that guide in regards to their use. In addition, Name to Use may be represented by setting `Patient.name.use` to "usual".

Usages:

- Use this Profile: Bundle (IPS)
- Refer to this Profile: AllergyIntolerance (IPS), Composition (IPS), Condition (IPS), DeviceUseStatement (IPS)... Show 14 more, DiagnosticReport (IPS), ImagingStudy (IPS), Immunization (IPS), MedicationRequest (IPS), MedicationStatement (IPS), Observation Social History - Alcohol Use (IPS), Observation Pregnancy - Expected Delivery Date (IPS), Observation Pregnancy - Outcome (IPS), Observation Pregnancy - Status (IPS), Observation Results - Laboratory/Pathology (IPS), Observation Results - Radiology (IPS), Observation Social History - Tobacco Use (IPS), Procedure (IPS) and Specimen (IPS)
- Examples for this Profile: Patient/66033, Patient/eumfh-39-07 and Patient/patient-example-female
- CapabilityStatements using this Profile: IPS Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

- Key Elements Table
- Differential Table
- Snapshot Table
- Obligations
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:genderIdentity |  | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:personalPronouns |  | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | SO Σ | 0..* | Identifier | An identifier for this patient
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
given | SO Σ | 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
gender | SO Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
birthDate | SO Σ | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | SO Σ | 0..* | Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
generalPractitioner | SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Patient |  |
Slices for extension |  |
identifier | SHALL:populate-if-known | SHALL:handle SHOULD:display
name | SHALL:populate | SHALL:handle SHOULD:display
use | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
family | SHALL:populate-if-known | SHALL:handle SHOULD:display
given | SHALL:populate-if-known | SHALL:handle SHOULD:display
telecom | SHALL:populate-if-known | SHALL:handle SHOULD:display
gender | SHALL:populate-if-known | SHALL:handle SHOULD:display
birthDate | SHALL:populate-if-known | SHALL:handle SHOULD:display
address | SHALL:populate-if-known | SHALL:handle SHOULD:display
generalPractitioner | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
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())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present | `family.exists() or given.exists() or text.exists()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  |  | Patient |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:genderIdentity |  | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:personalPronouns |  | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
identifier | SO | 0..* | Identifier | An identifier for this patient
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
name | SO C | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
use | SO | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
text | SO | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
family | SO | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
given | SO | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
telecom | SO | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
gender | SO | 0..1 | code | male | female | other | unknown
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
birthDate | SO | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
address | SO | 0..* | Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
generalPractitioner | SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Patient |  |
Slices for extension |  |
identifier | SHALL:populate-if-known | SHALL:handle SHOULD:display
name | SHALL:populate | SHALL:handle SHOULD:display
use | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
family | SHALL:populate-if-known | SHALL:handle SHOULD:display
given | SHALL:populate-if-known | SHALL:handle SHOULD:display
telecom | SHALL:populate-if-known | SHALL:handle SHOULD:display
gender | SHALL:populate-if-known | SHALL:handle SHOULD:display
birthDate | SHALL:populate-if-known | SHALL:handle SHOULD:display
address | SHALL:populate-if-known | SHALL:handle SHOULD:display
generalPractitioner | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present | `family.exists() or given.exists() or text.exists()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:genderIdentity |  | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:personalPronouns |  | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | SO Σ | 0..* | Identifier | An identifier for this patient
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
given | SO Σ | 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
gender | SO Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
birthDate | SO Σ | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | SO Σ | 0..* | Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner | SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Patient |  |
Slices for extension |  |
identifier | SHALL:populate-if-known | SHALL:handle SHOULD:display
name | SHALL:populate | SHALL:handle SHOULD:display
use | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
family | SHALL:populate-if-known | SHALL:handle SHOULD:display
given | SHALL:populate-if-known | SHALL:handle SHOULD:display
telecom | SHALL:populate-if-known | SHALL:handle SHOULD:display
gender | SHALL:populate-if-known | SHALL:handle SHOULD:display
birthDate | SHALL:populate-if-known | SHALL:handle SHOULD:display
address | SHALL:populate-if-known | SHALL:handle SHOULD:display
generalPractitioner | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📍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.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()`
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present | `family.exists() or given.exists() or text.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()`

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Patient |  |
Slices for extension |  |
identifier | SHALL:populate-if-known | SHALL:handle SHOULD:display
name | SHALL:populate | SHALL:handle SHOULD:display
use | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
family | SHALL:populate-if-known | SHALL:handle SHOULD:display
given | SHALL:populate-if-known | SHALL:handle SHOULD:display
telecom | SHALL:populate-if-known | SHALL:handle SHOULD:display
gender | SHALL:populate-if-known | SHALL:handle SHOULD:display
birthDate | SHALL:populate-if-known | SHALL:handle SHOULD:display
address | SHALL:populate-if-known | SHALL:handle SHOULD:display
generalPractitioner | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

Summary

Mandatory: 2 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1
- http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1

Maturity: 3

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:genderIdentity |  | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:personalPronouns |  | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | SO Σ | 0..* | Identifier | An identifier for this patient
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
given | SO Σ | 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
gender | SO Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
birthDate | SO Σ | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | SO Σ | 0..* | Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
generalPractitioner | SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Patient |  |
Slices for extension |  |
identifier | SHALL:populate-if-known | SHALL:handle SHOULD:display
name | SHALL:populate | SHALL:handle SHOULD:display
use | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
family | SHALL:populate-if-known | SHALL:handle SHOULD:display
given | SHALL:populate-if-known | SHALL:handle SHOULD:display
telecom | SHALL:populate-if-known | SHALL:handle SHOULD:display
gender | SHALL:populate-if-known | SHALL:handle SHOULD:display
birthDate | SHALL:populate-if-known | SHALL:handle SHOULD:display
address | SHALL:populate-if-known | SHALL:handle SHOULD:display
generalPractitioner | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
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())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present | `family.exists() or given.exists() or text.exists()`

Differential View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  |  | Patient |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:genderIdentity |  | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:personalPronouns |  | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
identifier | SO | 0..* | Identifier | An identifier for this patient
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
name | SO C | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
use | SO | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
text | SO | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
family | SO | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
given | SO | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
telecom | SO | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
gender | SO | 0..1 | code | male | female | other | unknown
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
birthDate | SO | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
address | SO | 0..* | Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
generalPractitioner | SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Patient |  |
Slices for extension |  |
identifier | SHALL:populate-if-known | SHALL:handle SHOULD:display
name | SHALL:populate | SHALL:handle SHOULD:display
use | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
family | SHALL:populate-if-known | SHALL:handle SHOULD:display
given | SHALL:populate-if-known | SHALL:handle SHOULD:display
telecom | SHALL:populate-if-known | SHALL:handle SHOULD:display
gender | SHALL:populate-if-known | SHALL:handle SHOULD:display
birthDate | SHALL:populate-if-known | SHALL:handle SHOULD:display
address | SHALL:populate-if-known | SHALL:handle SHOULD:display
generalPractitioner | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present | `family.exists() or given.exists() or text.exists()`

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:genderIdentity |  | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:personalPronouns |  | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | SO Σ | 0..* | Identifier | An identifier for this patient
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
given | SO Σ | 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
gender | SO Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
birthDate | SO Σ | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | SO Σ | 0..* | Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner | SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Patient |  |
Slices for extension |  |
identifier | SHALL:populate-if-known | SHALL:handle SHOULD:display
name | SHALL:populate | SHALL:handle SHOULD:display
use | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
family | SHALL:populate-if-known | SHALL:handle SHOULD:display
given | SHALL:populate-if-known | SHALL:handle SHOULD:display
telecom | SHALL:populate-if-known | SHALL:handle SHOULD:display
gender | SHALL:populate-if-known | SHALL:handle SHOULD:display
birthDate | SHALL:populate-if-known | SHALL:handle SHOULD:display
address | SHALL:populate-if-known | SHALL:handle SHOULD:display
generalPractitioner | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📍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.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()`
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present | `family.exists() or given.exists() or text.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()`

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Patient |  |
Slices for extension |  |
identifier | SHALL:populate-if-known | SHALL:handle SHOULD:display
name | SHALL:populate | SHALL:handle SHOULD:display
use | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
family | SHALL:populate-if-known | SHALL:handle SHOULD:display
given | SHALL:populate-if-known | SHALL:handle SHOULD:display
telecom | SHALL:populate-if-known | SHALL:handle SHOULD:display
gender | SHALL:populate-if-known | SHALL:handle SHOULD:display
birthDate | SHALL:populate-if-known | SHALL:handle SHOULD:display
address | SHALL:populate-if-known | SHALL:handle SHOULD:display
generalPractitioner | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

Summary

Mandatory: 2 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1
- http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1

Maturity: 3

Other representations of profile: CSV, Excel, Schematron