International Patient Summary Implementation Guide
2.0.0 - STU 2
International Patient Summary Implementation Guide
2.0.0 - STU 2
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
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Patient |
0..* | Patient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||
   extension:genderIdentity |
0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||
 extension:personalPronouns |
0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
 identifier |
SOΣ | 0..* | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children
| ||||||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children | ||||||||
| name |
SOΣC | 1..* | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
| ||||||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children | ||||||||
| text |
SOΣ | 0..1 | string | Text representation of the full name ele-1: All FHIR elements must have a @value or children
| ||||||||
| family |
SOΣ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
| ||||||||
 given |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||||
| telecom |
SOΣ | 0..* | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children
| ||||||||
| gender |
SOΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
| ||||||||
| birthDate |
SOΣ | 1..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children
| ||||||||
 deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children | |||||||||
| deceasedBoolean |
boolean | |||||||||||
| deceasedDateTime |
dateTime | |||||||||||
| address |
SOΣ | 0..* | Address | An address for the individual ele-1: All FHIR elements must have a @value or children
| ||||||||
 generalPractitioner |
SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children
| ||||||||
 link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children | ||||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children | ||||||||
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children | ||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet | URI |
| Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | |
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#2.0.0 based on FHIR 4.0.1. Generated 2025-04-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
