International Patient Summary Implementation Guide
1.0.0 - CI Build
International Patient Summary Implementation Guide
1.0.0 - CI Build
International Patient Summary Implementation Guide, published by Health Level Seven International - Patient Care Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions
Clinical document used to represent the International Patient Summary (IPS) data set. An International Patient Summary (IPS) document is an electronic health record extract containing essential healthcare information about a subject of care. The IPS dataset is minimal and non-exhaustive; specialty-agnostic and condition-independent; but still clinically relevant. As specified in EN 17269 and ISO/DIS 27269, it is designed for supporting the use case scenario for ‘unplanned, cross border care’, but it is not limited to it. It is intended to be international, i.e., to provide generic solutions for global application beyond a particular region or country.
This profile is based on the ClinicalDocument profile.
The official URL for this profile is:
http://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips
In this version of the guide the Medication Summary is expressed as a list of MedicationStatements. The reason for this choice is explained in the Design Conventions and Principles page.
STU implementers are encouraged to provide their feedback about this design choice.
Particularly in light of the currect state of global health and the response to the COVID-19 pandemic due to the SARS-CoV-2 virus, extending the IPS Immunizations section to also include, when relevant, the status of immunity to specific target diseases is being considered. The potential updates to this implementation guide to incorporate this capability are still being discussed and have not been included in this initial published version of the guide. These proposed updates may include revising the Immunization section description to reflect this broadened scope (as IPS Immunizations/Immune Status Section, or similar), as a presumed or verified status of immunity to a disease is, in fact, the intended and desired outcome of a vaccination/immunization.
The capability to record a statement of immunity to a disease could be provided via a profile on the Condition resource and specific "immune status" codes (a set of "Finding of immune status" codes is currently available in SNOMED CT - however, at this time, a code representing "Immunity to COVID-19" or the equivalent is not available). The Condition resource may be appropriate for this purpose, as immunity (including, in some cases, a statement of "no immunity") is an ongoing state of the patient for some period of time (once immunity is acquired, typically for multiple years). The statement of immunity is not simply an observation at a point in time, although a statement of immunity would be expected in the case of COVID-19 and in many or most other cases to have associated observations that are necessary for providing the supporting evidence for the "immunity" condition.
As specific profiling is not yet available in the current IG publication to support the representation of a statement of immunity, the open slicing approach for including additional data in an IPS instance may be used. An example of of how this might be done is available in the 'immune-status' and potentially other branches of the IPS IG specification continuous integration (CI) build - link available by request from ips@lists.hl7.org or in the FHIR Zulip chat IPS Community of Practice stream.
Reviewers and implementers of this STU are encouraged to provide their feedback about this need and any questions, suggestions or concerns regarding the example profiles or other alternative approaches to addressing this situation. Any proposed solutions to be considered for inclusion in a future version of this guide will be subject to evaluation by the wider cross-SDO IPS community as well as the broader standards community and where possible relevant public health authorities (global, national and regional), in order to ensure to the extent possible that any solution that is adopted will be appropriate, usable and clinically sound.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Clinical Document
Summary
Mandatory: 19 elements (44 nested mandatory elements)
Must-Support: 110 elements
Prohibited: 28 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Clinical Document
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | S | 0..* | Clinical Document | International Patient Summary composition |
  text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| identifier | S | 0..1 | Identifier | Version-independent identifier for the Composition |
| status | S | 1..1 | code | preliminary | final | amended | entered-in-error |
  type | S | 1..1 | CodeableConceptIPS | Kind of composition ("Patient Summary") Required Pattern: At least the following |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 60591-5 | |
 subject | S | 0..1 | Reference(Patient (IPS)) | Who and/or what the composition is about |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| encounter | S | 0..1 | Reference(Encounter) | Context of the Composition |
| date | S | 1..1 | dateTime | Composition editing time |
| author | S | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the IPS |
| title | S | 1..1 | string | International Patient Summary |
| confidentiality | S | 0..1 | code | As defined by affinity domain |
| attester | S | 0..* | BackboneElement | Attests to accuracy of composition |
| mode | S | 1..1 | code | personal | professional | legal | official |
| time | S | 0..1 | dateTime | When the composition was attested |
| party | S | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition |
| custodian | S | 0..1 | Reference(Organization) | Organization which maintains the composition |
| relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents |
| code | S | 1..1 | code | replaces | transforms | signs | appends |
 target[x] | S | 1..1 | Target of the relationship | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition | Composition (IPS)) | |||
 event | S | 0..* | (Slice Definition) | The clinical service(s) being documented Slice: Unordered, Open by pattern:code |
  event:careProvisioningEvent | S | 0..1 | BackboneElement | The care provisioning being documented |
 code | S | 1..* | CodeableConcept | Code(s) that apply to the event being documented Required Pattern: At least the following |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActClass | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PCPR | |
 period | S | 0..1 | Period | The period covered by the documentation |
| section | S | 1..* | (Slice Definition) | Sections composing the IPS Slice: Unordered, Open by pattern:code |
 section:sectionMedications | S | 1..1 | BackboneElement | IPS Medication Summary Section |
  title | S | 1..1 | string | Medication Summary section |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 10160-0 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 1..* | (Slice Definition) | Medications relevant for the scope of the patient summary Slice: Unordered, Open by profile:$this.resolve() |
 entry:medicationStatement | S | 1..* | Reference(Medication Statement (IPS)) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionAllergies | S | 1..1 | BackboneElement | IPS Allergies and Intolerances Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 48765-2 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 1..* | (Slice Definition) | Relevant allergies or intolerances (conditions) for that patient. Slice: Unordered, Open by profile:$this.resolve() |
| entry:allergyOrIntolerance | S | 1..* | Reference(Allergy Intolerance (IPS)) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionProblems | S | 1..1 | BackboneElement | IPS Problems Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 11450-4 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 1..* | (Slice Definition) | Clinical problems or conditions currently being monitored for the patient. Slice: Unordered, Open by profile:$this.resolve() |
| entry:problem | S | 1..* | Reference(Condition (IPS)) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionProceduresHx | S | 0..1 | BackboneElement | IPS History of Procedures Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 47519-4 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 1..* | (Slice Definition) | Patient past procedures pertinent to the scope of this document. Slice: Unordered, Open by profile:$this.resolve() |
| entry:procedure | S | 1..* | Reference(Procedure (IPS)) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionImmunizations | S | 0..1 | BackboneElement | IPS Immunizations Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 11369-6 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 1..* | (Slice Definition) | Patient's immunization status and pertinent history. Slice: Unordered, Open by profile:$this.resolve() |
| entry:immunization | S | 1..* | Reference(Immunization (IPS)) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionMedicalDevices | S | 0..1 | BackboneElement | IPS Medical Devices Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 46264-8 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 1..* | (Slice Definition) | Patient history of medical device use. Slice: Unordered, Open by profile:$this.resolve() |
| entry:deviceStatement | S | 1..* | Reference(Device Use Statement (IPS)) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionResults | S | 0..1 | BackboneElement | IPS Results Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 30954-2 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 1..* | (Slice Definition) | Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Slice: Unordered, Open by type:$this.resolve(), profile:$this.resolve() |
 entry:results-observation | S | 0..* | Reference(Observation Results: laboratory (IPS) | Observation Results: pathology (IPS) | Observation Results: radiology (IPS) | Observation Results (IPS)) | A reference to data that supports this section |
| entry:results-diagnosticReport | S | 0..* | Reference(DiagnosticReport (IPS)) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionVitalSigns | S | 0..1 | BackboneElement | IPS Vital Signs Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8716-3 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 0..* | (Slice Definition) | Notable vital signs or physical findings. Slice: Unordered, Open by profile:$this.resolve() |
| entry:vitalSign | S | 0..* | Reference(Vital Signs Profile) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionPastIllnessHx | S | 0..1 | BackboneElement | IPS History of Past Illness Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 11348-0 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 1..* | (Slice Definition) | Conditions the patient suffered in the past. Slice: Unordered, Open by profile:$this.resolve() |
| entry:pastProblem | S | 1..* | Reference(Condition (IPS)) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionFunctionalStatus | S | 0..1 | BackboneElement | IPS Functional Status |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 47420-5 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 0..* | (Slice Definition) | Optional entry used to represent disabilities and functional assessments Slice: Unordered, Open by profile:$this.resolve() |
| entry:disability | S | 0..* | Reference(Condition (IPS)) | A reference to data that supports this section |
| entry:functionalAssessment | S | 0..* | Reference(ClinicalImpression) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionPlanOfCare | S | 0..1 | BackboneElement | IPS Plan of Care Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 18776-5 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | 0..* | (Slice Definition) | Optional entry used to represent structured care plans Slice: Unordered, Open by profile:$this.resolve() | |
| entry:carePlan | 0..* | Reference(CarePlan) | A reference to data that supports this section | |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionSocialHistory | S | 0..1 | BackboneElement | IPS Social History Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 29762-2 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 0..* | (Slice Definition) | Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.) Slice: Unordered, Open by profile:$this.resolve() |
| entry:smokingTobaccoUse | S | 0..1 | Reference(Observation (SH: tobacco use)) | A reference to data that supports this section |
| entry:alcoholUse | S | 0..1 | Reference(Observation (SH: alcohol use)) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionPregnancyHx | S | 0..1 | BackboneElement | IPS History of Pregnancy Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 10162-6 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 0..* | (Slice Definition) | Current pregnancy status and, optionally, information about the outcome of earlier pregnancies. Slice: Unordered, Open by profile:$this.resolve() |
| entry:pregnancyStatus | S | 0..* | Reference(Observation (Pregnancy: status)) | A reference to data that supports this section |
| entry:pregnancyOutcomeSummary | S | 0..* | Reference(Observation (Pregnancy: outcome)) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| section:sectionAdvanceDirectives | S | 0..1 | BackboneElement | IPS Advance Directives Section |
| title | S | 1..1 | string | Label for section (e.g. for ToC) |
| code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 42348-3 | |
| text | S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| entry | S | 0..* | (Slice Definition) | Narrative description of the patient's advance directive. Slice: Unordered, Open by profile:$this.resolve() |
| entry:advanceDirectivesConsent | S | 0..* | Reference(Consent) | A reference to data that supports this section |
| emptyReason | 0..0 | |||
| section | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | SI | 0..* | Clinical Document | International Patient Summary composition |
 id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | SI | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| composition-clinicaldocument-versionNumber | I | 0..* | string | Version-specific identifier for composition URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣI | 0..1 | Identifier | Version-independent identifier for the Composition |
| status | ?!SΣI | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | SI | 1..1 | CodeableConceptIPS | Kind of composition ("Patient Summary") Binding: FHIRDocumentTypeCodes (preferred) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 60591-5 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| category | ΣI | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example) |
| subject | SΣI | 0..1 | Reference(Patient (IPS)) | Who and/or what the composition is about |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| encounter | SΣI | 0..1 | Reference(Encounter) | Context of the Composition |
| date | SΣI | 1..1 | dateTime | Composition editing time |
| author | SΣI | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the IPS |
| title | SΣI | 1..1 | string | International Patient Summary |
| confidentiality | SΣI | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required) |
| attester | SI | 0..* | BackboneElement | Attests to accuracy of composition |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | SI | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | SI | 0..1 | dateTime | When the composition was attested |
| party | SI | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition |
| custodian | SΣI | 0..1 | Reference(Organization) | Organization which maintains the composition |
| relatesTo | SI | 0..* | BackboneElement | Relationships to other compositions/documents |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SI | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
| target[x] | SI | 1..1 | Target of the relationship | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition | Composition (IPS)) | |||
| event | SΣI | 0..* | (Slice Definition) | The clinical service(s) being documented Slice: Unordered, Open by pattern:code |
| event:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | ΣI | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example) |
| period | ΣI | 0..1 | Period | The period covered by the documentation |
| detail | ΣI | 0..* | Reference(Resource) | The event(s) being documented |
| event:careProvisioningEvent | SΣI | 0..1 | BackboneElement | The care provisioning being documented |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣI | 1..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActClass | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PCPR | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| period | SΣI | 0..1 | Period | The period covered by the documentation |
| detail | ΣI | 0..* | Reference(Resource) | The event(s) being documented |
| section | SI | 1..* | (Slice Definition) | Sections composing the IPS Slice: Unordered, Open by pattern:code |
| section:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | I | 0..1 | string | Label for section (e.g. for ToC) |
| code | I | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example) |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | I | 0..* | Reference(Resource) | A reference to data that supports this section |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred) |
| section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
| section:sectionMedications | SI | 1..1 | BackboneElement | IPS Medication Summary Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | SI | 1..1 | string | Medication Summary section |
| code | SI | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: DocumentSectionCodes (example) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 10160-0 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | SI | 1..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
 entry | SI | 1..* | (Slice Definition) | Medications relevant for the scope of the patient summary Slice: Unordered, Open by profile:$this.resolve() |
| entry:medicationStatement | SI | 1..* | Reference(Medication Statement (IPS)) | A reference to data that supports this section |
| section:sectionAllergies | SI | 1..1 | BackboneElement | IPS Allergies and Intolerances Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | SI | 1..1 | string | Label for section (e.g. for ToC) |
| code | SI | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: DocumentSectionCodes (example) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 48765-2 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | SI | 1..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | SI | 1..* | (Slice Definition) | Relevant allergies or intolerances (conditions) for that patient. Slice: Unordered, Open by profile:$this.resolve() |
| entry:allergyOrIntolerance | SI | 1..* | Reference(Allergy Intolerance (IPS)) | A reference to data that supports this section |
| section:sectionProblems | SI | 1..1 | BackboneElement | IPS Problems Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | SI | 1..1 | string | Label for section (e.g. for ToC) |
| code | SI | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: DocumentSectionCodes (example) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 11450-4 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | SI | 1..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | SI | 1..* | (Slice Definition) | Clinical problems or conditions currently being monitored for the patient. Slice: Unordered, Open by profile:$this.resolve() |
| entry:problem | SI | 1..* | Reference(Condition (IPS)) | A reference to data that supports this section |
| section:sectionProceduresHx | SI | 0..1 | BackboneElement | IPS History of Procedures Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | SI | 1..1 | string | Label for section (e.g. for ToC) |
| code | SI | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: DocumentSectionCodes (example) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 47519-4 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | SI | 1..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | SI | 1..* | (Slice Definition) | Patient past procedures pertinent to the scope of this document. Slice: Unordered, Open by profile:$this.resolve() |
| entry:procedure | SI | 1..* | Reference(Procedure (IPS)) | A reference to data that supports this section |
| section:sectionImmunizations | SI | 0..1 | BackboneElement | IPS Immunizations Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | SI | 1..1 | string | Label for section (e.g. for ToC) |
| code | SI | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: DocumentSectionCodes (example) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 11369-6 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | SI | 1..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | SI | 1..* | (Slice Definition) | Patient's immunization status and pertinent history. Slice: Unordered, Open by profile:$this.resolve() |
| entry:immunization | SI | 1..* | Reference(Immunization (IPS)) | A reference to data that supports this section |
| section:sectionMedicalDevices | SI | 0..1 | BackboneElement | IPS Medical Devices Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | SI | 1..1 | string | Label for section (e.g. for ToC) |
| code | SI | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: DocumentSectionCodes (example) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 46264-8 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | SI | 1..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | SI | 1..* | (Slice Definition) | Patient history of medical device use. Slice: Unordered, Open by profile:$this.resolve() |
| entry:deviceStatement | SI | 1..* | Reference(Device Use Statement (IPS)) | A reference to data that supports this section |
| section:sectionResults | SI | 0..1 | BackboneElement | IPS Results Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | SI | 1..1 | string | Label for section (e.g. for ToC) |
| code | SI | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: DocumentSectionCodes (example) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 30954-2 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | SI | 1..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | SI | 1..* | (Slice Definition) | Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Slice: Unordered, Open by type:$this.resolve(), profile:$this.resolve() |
| entry:results-observation | SI | 0..* | Reference(Observation Results: laboratory (IPS) | Observation Results: pathology (IPS) | Observation Results: radiology (IPS) | Observation Results (IPS)) | A reference to data that supports this section |
| entry:results-diagnosticReport | SI | 0..* | Reference(DiagnosticReport (IPS)) | A reference to data that supports this section |
| section:sectionVitalSigns | SI | 0..1 | BackboneElement | IPS Vital Signs Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | SI | 1..1 | string | Label for section (e.g. for ToC) |
| code | SI | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: DocumentSectionCodes (example) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8716-3 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| author | I | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section |
| focus | I | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition |
| text | SI | 1..1 | Narrative | Text summary of the section, for human interpretation |
| mode | I | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | I | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred) |
| entry | SI | 0..* | (Slice Definition) | Notable vital signs or physical findings. Slice: Unordered, Open by profile:$this.resolve() |
| entry:vitalSign | SI | 0..* | Reference(Vital Signs Profile) | A reference to data that supports this section |
| section:sectionPastIllnessHx | SI | 0..1 | BackboneElement | IPS History of Past Illness Section |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | SI | 1..1 | string | Label for section (e.g. for ToC) |
| code | SI | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: DocumentSectionCodes (example) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 11348-0 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
|