International Patient Summary (IPS)
1.1.0-ballot - CI Build
International Patient Summary (IPS)
1.1.0-ballot - CI Build
International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions
| Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.15--20240612085101 | Version: 1.1.0-ballot | |||
| Draft as of 2024-06-12 | Computable Name: IPSAlertsSection | |||
| Other Identifiers: OID:2.16.840.1.113883.10.22.15 (use: official, ) | ||||
The ‘Alert’ Section brings the most important healthcare information to the fore.
This section highlights extreme problem(s). Previously, ‘alerts’ were just reported as ‘problems’, which carried the risk of losing the immediacy and importance of information to the attending clinician.
An alert in meant to be “Information used to warn or call to a state of preparedness. Information flagged (or intended) to raise awareness of a potential danger to/from the subject of the IPS or to/from another individual or awareness of a potential obstacle to care.”
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Section
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Section |
0..* | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources XML: cda (urn:hl7-org:v3) Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:primary |
S | 1..1 | II | XML: cda (urn:hl7-org:v3) |
   @root |
1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.15 | |
| code |
S | 1..1 | CE | XML: cda (urn:hl7-org:v3) |
 @code |
0..1 | cs | Fixed Value: 104605-1 | |
 @codeSystem |
0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
| title |
S | 1..1 | ST | XML: cda (urn:hl7-org:v3) |
| text |
S | 1..1 | xhtml | XML: cda (urn:hl7-org:v3) |
| Slices for entry |
1..* | Entry | Slice: Unordered, Open by value:profile | |
| entry:entry-1 |
SC | 1..1 | Entry | XML: cda (urn:hl7-org:v3) entry-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) |
 Slices for act |
Content/Rules for all slices | |||
 act:entry-1 |
S | 0..* | IPSEntryInternalReference | Base for all types and resources |
 Slices for component |
1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
| component:component-1 |
C | 1..1 | InfrastructureRoot | component-1: contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) |
| Slices for section |
Content/Rules for all slices | |||
| section:component-1 |
0..* | IPSTranslationSection | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
| entry-1 | null | Section.entry:entry-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section |
0..* | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources XML: cda (urn:hl7-org:v3) Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary |
S | 1..1 | II | XML: cda (urn:hl7-org:v3) |
| @root |
1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.15 | |
 code |
S | 1..1 | CE | XML: cda (urn:hl7-org:v3) Binding: DocumentSectionType (example) |
| @code |
0..1 | cs | Fixed Value: 104605-1 | |
| @codeSystem |
0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
| title |
S | 1..1 | ST | XML: cda (urn:hl7-org:v3) |
| text |
S | 1..1 | xhtml | XML: cda (urn:hl7-org:v3) |
| Slices for entry |
1..* | Entry | Slice: Unordered, Open by value:profile | |
| entry:entry-1 |
SC | 1..1 | Entry | XML: cda (urn:hl7-org:v3) entry-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) |
| Slices for act |
Content/Rules for all slices | |||
| act:entry-1 |
SC | 0..* | IPSEntryInternalReference | Base for all types and resources MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document. MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element |
| Slices for component |
1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
 component:All Slices |
Content/Rules for all slices | |||
 section |
1..1 | Section | ||
| component:component-1 |
C | 1..1 | InfrastructureRoot | component-1: contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) |
| Slices for section |
Content/Rules for all slices | |||
| section:component-1 |
0..* | IPSTranslationSection | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType |
| Id | Grade | Path(s) | Details | Requirements |
| MD1557037N1l27l287l23l17 | error | Section.entry:entry-1.act:entry-1 | The @moodCode of the reference SHALL match the @moodCode of the referenced element : | |
| MD1557037N1l27l287l23l19 | error | Section.entry:entry-1.act:entry-1 | The root and extension attributes SHALL identify an element defined elsewhere in the same document. : | |
| MD1557037N1l27l287l23l21 | error | Section.entry:entry-1.act:entry-1 | The code of the reference SHALL match the code of the referenced element : | |
| component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
| entry-1 | null | Section.entry:entry-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section |
0..* | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources XML: cda (urn:hl7-org:v3) Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary |
S | 1..1 | II | XML: cda (urn:hl7-org:v3) |
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.15 | |
| @extension |
0..1 | st | ||
| @ID |
0..1 | xs:ID | ||
| @classCode |
0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..1 | II | ||
| code |
S | 1..1 | CE | XML: cda (urn:hl7-org:v3) Binding: DocumentSectionType (example) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
0..1 | cs | Fixed Value: 104605-1 | |
| @codeSystem |
0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| title |
S | 1..1 | ST | XML: cda (urn:hl7-org:v3) |
| text |
S | 1..1 | xhtml | XML: cda (urn:hl7-org:v3) |
| confidentialityCode |
0..1 | CE | ||
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for entry |
1..* | Entry | Slice: Unordered, Open by value:profile | |
| entry:entry-1 |
SC | 1..1 | Entry | XML: cda (urn:hl7-org:v3) entry-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
 typeId |
0..1 | II | ||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| Slices for act |
Content/Rules for all slices | |||
| act:entry-1 |
SC | 0..* | IPSEntryInternalReference | Base for all types and resources MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document. MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element |
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| Slices for component |
1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
| component:All Slices |
Content/Rules for all slices | |||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Fixed Value: COMP | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| section |
1..1 | Section | ||
| component:component-1 |
C | 1..1 | InfrastructureRoot | component-1: contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Fixed Value: COMP | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| Slices for section |
Content/Rules for all slices | |||
| section:component-1 |
0..* | IPSTranslationSection | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.classCode | required | Fixed Value: DOCSECThttp://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer | |
| Section.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType | |
| Section.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
| Section.entry:entry-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:entry-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:entry-1.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
| Section.component.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.component.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.component:component-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.component:component-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| MD1557037N1l27l287l23l17 | error | Section.entry:entry-1.act:entry-1 | The @moodCode of the reference SHALL match the @moodCode of the referenced element : | |
| MD1557037N1l27l287l23l19 | error | Section.entry:entry-1.act:entry-1 | The root and extension attributes SHALL identify an element defined elsewhere in the same document. : | |
| MD1557037N1l27l287l23l21 | error | Section.entry:entry-1.act:entry-1 | The code of the reference SHALL match the code of the referenced element : | |
| component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
| entry-1 | null | Section.entry:entry-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
This structure is derived from Section
Summary
Mandatory: 10 elements
Must-Support: 6 elements
Fixed: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Section
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section |
0..* | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources XML: cda (urn:hl7-org:v3) Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary |
S | 1..1 | II | XML: cda (urn:hl7-org:v3) |
| @root |
1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.15 | |
| code |
S | 1..1 | CE | XML: cda (urn:hl7-org:v3) |
| @code |
0..1 | cs | Fixed Value: 104605-1 | |
| @codeSystem |
0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
| title |
S | 1..1 | ST | XML: cda (urn:hl7-org:v3) |
| text |
S | 1..1 | xhtml | XML: cda (urn:hl7-org:v3) |
| Slices for entry |
1..* | Entry | Slice: Unordered, Open by value:profile | |
| entry:entry-1 |
SC | 1..1 | Entry | XML: cda (urn:hl7-org:v3) entry-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) |
| Slices for act |
Content/Rules for all slices | |||
| act:entry-1 |
S | 0..* | IPSEntryInternalReference | Base for all types and resources |
| Slices for component |
1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
| component:component-1 |
C | 1..1 | InfrastructureRoot | component-1: contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) |
| Slices for section |
Content/Rules for all slices | |||
| section:component-1 |
0..* | IPSTranslationSection | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
| entry-1 | null | Section.entry:entry-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section |
0..* | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources XML: cda (urn:hl7-org:v3) Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary |
S | 1..1 | II | XML: cda (urn:hl7-org:v3) |
| @root |
1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.15 | |
| code |
S | 1..1 | CE | XML: cda (urn:hl7-org:v3) Binding: DocumentSectionType (example) |
| @code |
0..1 | cs | Fixed Value: 104605-1 | |
| @codeSystem |
0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
| title |
S | 1..1 | ST | XML: cda (urn:hl7-org:v3) |
| text |
S | 1..1 | xhtml | XML: cda (urn:hl7-org:v3) |
| Slices for entry |
1..* | Entry | Slice: Unordered, Open by value:profile | |
| entry:entry-1 |
SC | 1..1 | Entry | XML: cda (urn:hl7-org:v3) entry-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) |
| Slices for act |
Content/Rules for all slices | |||
| act:entry-1 |
SC | 0..* | IPSEntryInternalReference | Base for all types and resources MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document. MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element |
| Slices for component |
1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
| component:All Slices |
Content/Rules for all slices | |||
| section |
1..1 | Section | ||
| component:component-1 |
C | 1..1 | InfrastructureRoot | component-1: contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) |
| Slices for section |
Content/Rules for all slices | |||
| section:component-1 |
0..* | IPSTranslationSection | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType |
| Id | Grade | Path(s) | Details | Requirements |
| MD1557037N1l27l287l23l17 | error | Section.entry:entry-1.act:entry-1 | The @moodCode of the reference SHALL match the @moodCode of the referenced element : | |
| MD1557037N1l27l287l23l19 | error | Section.entry:entry-1.act:entry-1 | The root and extension attributes SHALL identify an element defined elsewhere in the same document. : | |
| MD1557037N1l27l287l23l21 | error | Section.entry:entry-1.act:entry-1 | The code of the reference SHALL match the code of the referenced element : | |
| component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
| entry-1 | null | Section.entry:entry-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section |
0..* | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources XML: cda (urn:hl7-org:v3) Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary |
S | 1..1 | II | XML: cda (urn:hl7-org:v3) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.15 | |
| @extension |
0..1 | st | ||
| @ID |
0..1 | xs:ID | ||
| @classCode |
0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..1 | II | ||
| code |
S | 1..1 | CE | XML: cda (urn:hl7-org:v3) Binding: DocumentSectionType (example) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
0..1 | cs | Fixed Value: 104605-1 | |
| @codeSystem |
0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| title |
S | 1..1 | ST | XML: cda (urn:hl7-org:v3) |
| text |
S | 1..1 | xhtml | XML: cda (urn:hl7-org:v3) |
| confidentialityCode |
0..1 | CE | ||
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for entry |
1..* | Entry | Slice: Unordered, Open by value:profile | |
| entry:entry-1 |
SC | 1..1 | Entry | XML: cda (urn:hl7-org:v3) entry-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| Slices for act |
Content/Rules for all slices | |||
| act:entry-1 |
SC | 0..* | IPSEntryInternalReference | Base for all types and resources MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document. MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element |
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| Slices for component |
1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
| component:All Slices |
Content/Rules for all slices | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Fixed Value: COMP | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| section |
1..1 | Section | ||
| component:component-1 |
C | 1..1 | InfrastructureRoot | component-1: contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Fixed Value: COMP | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| Slices for section |
Content/Rules for all slices | |||
| section:component-1 |
0..* | IPSTranslationSection | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.classCode | required | Fixed Value: DOCSECThttp://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer | |
| Section.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType | |
| Section.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
| Section.entry:entry-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:entry-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:entry-1.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
| Section.component.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.component.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.component:component-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.component:component-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| MD1557037N1l27l287l23l17 | error | Section.entry:entry-1.act:entry-1 | The @moodCode of the reference SHALL match the @moodCode of the referenced element : | |
| MD1557037N1l27l287l23l19 | error | Section.entry:entry-1.act:entry-1 | The root and extension attributes SHALL identify an element defined elsewhere in the same document. : | |
| MD1557037N1l27l287l23l21 | error | Section.entry:entry-1.act:entry-1 | The code of the reference SHALL match the code of the referenced element : | |
| component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
| entry-1 | null | Section.entry:entry-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
This structure is derived from Section
Summary
Mandatory: 10 elements
Must-Support: 6 elements
Fixed: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2024+ Health Level Seven. Package hl7.cda.uv.ips#1.1.0-ballot based on FHIR 4.0.1. Generated 2024-08-19
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change