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

Logical Model: IPS Planned Encounter

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.40--20200508181838 Version: 1.1.0-ballot
Draft as of 2020-05-08 Computable Name: IPSPlannedEncounter
Other Identifiers: OID:2.16.840.1.113883.10.22.4.40 (use: official, )

An Encounter is an interaction between a patient and care provider(s) for the purpose of providing healthcare-related service(s). Healthcare services include health assessment. Examples: outpatient visit to multiple departments, home health support (including physical therapy), inpatient hospital stay, emergency room visit, field visit (e.g., traffic accident), office visit, occupational therapy, or telephone call.

Usage:

  • This Logical Model is not used by any profiles in this Implementation Guide

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
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
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.40
... @classCode 0..1 code Fixed Value: ENC
... @moodCode 1..1 code Required Pattern: PRP
... code S 1..1 CD
... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... effectiveTime 0..1 IVL_TS
... priorityCode 0..1 CE
... performer 0..* Performer2
.... time 0..1 IVL_TS
... participant 0..* Participant2
.... @typeCode 1..1 code Fixed Value: LOC
.... participantRole S 1..1 ParticipantRole
..... @classCode 1..1 code Fixed Value: SDLOC
..... id 0..* II
..... code 0..1 CE
..... addr 0..* AD
..... telecom 0..* TEL
..... playingEntity S 1..1 PlayingEntity
...... @classCode 1..1 code Fixed Value: PLC
...... name S 1..* PN

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
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
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.40
... @classCode 0..1 code Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 code Binding: XDocumentEncounterMood (2.0.0) (required)
Required Pattern: PRP
... code S 1..1 CD Binding: ActEncounterCode (example)
... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... effectiveTime 0..1 IVL_TS
... priorityCode 0..1 CE Binding: ActPriority (example)
... performer 0..* Performer2
.... time 0..1 IVL_TS
.... assignedEntity 1..1 AssignedEntity
... participant 0..* Participant2
.... @typeCode 1..1 code Binding: CDAParticipationType (required)
Fixed Value: LOC
.... participantRole S 1..1 ParticipantRole
..... @classCode 1..1 code Binding: CDARoleClassRoot (required)
Fixed Value: SDLOC
..... id 0..* II
..... code 0..1 CE Binding: CDARoleCode (example)
..... addr 0..* AD
..... telecom 0..* TEL
..... playingEntity S 1..1 PlayingEntity
...... @classCode 1..1 code Binding: EntityClassRoot (required)
Fixed Value: PLC
...... name S 1..* PN

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
Encounter.moodCoderequiredPattern: PRP
http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0
Encounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeCoderequiredFixed Value: LOC
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Encounter.participant.participantRole.classCoderequiredFixed Value: SDLOC
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
Encounter.participant.participantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
Encounter.participant.participantRole.playingEntity.classCoderequiredFixed Value: PLC
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
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
.... templateId:primary S 1..1 II
..... @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.4.40
..... @extension 0..1 st
... @classCode 0..1 code Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 code Binding: XDocumentEncounterMood (2.0.0) (required)
Required Pattern: PRP
... id S 0..* II
... code S 1..1 CD Binding: ActEncounterCode (example)
... text S 0..1 ED
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference S 1..1 TEL
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @value 1..1 url
..... useablePeriod 0..*
...... useablePeriod IVL_TS
...... useablePeriod EIVL_TS
...... useablePeriod PIVL_TS
...... useablePeriod SXPR_TS
..... @use 0..* cs Binding: TelecommunicationAddressUse (2.0.0) (required)
.... thumbnail 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..1 IVL_TS
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
.... @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: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... modeCode 0..1 CE
.... assignedEntity 1..1 AssignedEntity
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
.... @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 1..1 code Binding: CDAParticipationType (required)
Fixed Value: LOC
.... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... awarenessCode 0..1 CE
.... participantRole S 1..1 ParticipantRole
..... @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
..... @classCode 1..1 code Binding: CDARoleClassRoot (required)
Fixed Value: SDLOC
..... id 0..* II
..... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1 CE Binding: CDARoleCode (example)
..... addr 0..* AD
..... telecom 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity S 1..1 PlayingEntity
...... @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
...... @classCode 1..1 code Binding: EntityClassRoot (required)
Fixed Value: PLC
...... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code 0..1 CE Binding: CDAEntityCode (example)
...... quantity 0..* PQ
...... name S 1..* PN
...... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
...... desc 0..1 ED
..... scopingEntity 0..1 Entity
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
Encounter.moodCoderequiredPattern: PRP
http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0
Encounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Encounter.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Encounter.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Encounter.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Encounter.text.reference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.text.reference.userequiredTelecommunicationAddressUse
http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.performer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeCoderequiredFixed Value: PRF
http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer
Encounter.participant.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.typeCoderequiredFixed Value: LOC
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Encounter.participant.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Encounter.participant.participantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.participantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.participantRole.classCoderequiredFixed Value: SDLOC
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
Encounter.participant.participantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
Encounter.participant.participantRole.playingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.participantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.participantRole.playingEntity.classCoderequiredFixed Value: PLC
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Encounter.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Encounter.participant.participantRole.playingEntity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

This structure is derived from Encounter

Summary

Mandatory: 5 elements(8 nested mandatory elements)
Must-Support: 8 elements
Fixed: 5 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Encounter.templateId

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
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
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.40
... @classCode 0..1 code Fixed Value: ENC
... @moodCode 1..1 code Required Pattern: PRP
... code S 1..1 CD
... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... effectiveTime 0..1 IVL_TS
... priorityCode 0..1 CE
... performer 0..* Performer2
.... time 0..1 IVL_TS
... participant 0..* Participant2
.... @typeCode 1..1 code Fixed Value: LOC
.... participantRole S 1..1 ParticipantRole
..... @classCode 1..1 code Fixed Value: SDLOC
..... id 0..* II
..... code 0..1 CE
..... addr 0..* AD
..... telecom 0..* TEL
..... playingEntity S 1..1 PlayingEntity
...... @classCode 1..1 code Fixed Value: PLC
...... name S 1..* PN

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
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
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.40
... @classCode 0..1 code Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 code Binding: XDocumentEncounterMood (2.0.0) (required)
Required Pattern: PRP
... code S 1..1 CD Binding: ActEncounterCode (example)
... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... effectiveTime 0..1 IVL_TS
... priorityCode 0..1 CE Binding: ActPriority (example)
... performer 0..* Performer2
.... time 0..1 IVL_TS
.... assignedEntity 1..1 AssignedEntity
... participant 0..* Participant2
.... @typeCode 1..1 code Binding: CDAParticipationType (required)
Fixed Value: LOC
.... participantRole S 1..1 ParticipantRole
..... @classCode 1..1 code Binding: CDARoleClassRoot (required)
Fixed Value: SDLOC
..... id 0..* II
..... code 0..1 CE Binding: CDARoleCode (example)
..... addr 0..* AD
..... telecom 0..* TEL
..... playingEntity S 1..1 PlayingEntity
...... @classCode 1..1 code Binding: EntityClassRoot (required)
Fixed Value: PLC
...... name S 1..* PN

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
Encounter.moodCoderequiredPattern: PRP
http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0
Encounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeCoderequiredFixed Value: LOC
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Encounter.participant.participantRole.classCoderequiredFixed Value: SDLOC
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
Encounter.participant.participantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
Encounter.participant.participantRole.playingEntity.classCoderequiredFixed Value: PLC
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
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
.... templateId:primary S 1..1 II
..... @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.4.40
..... @extension 0..1 st
... @classCode 0..1 code Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 code Binding: XDocumentEncounterMood (2.0.0) (required)
Required Pattern: PRP
... id S 0..* II
... code S 1..1 CD Binding: ActEncounterCode (example)
... text S 0..1 ED
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference S 1..1 TEL
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @value 1..1 url
..... useablePeriod 0..*
...... useablePeriod IVL_TS
...... useablePeriod EIVL_TS
...... useablePeriod PIVL_TS
...... useablePeriod SXPR_TS
..... @use 0..* cs Binding: TelecommunicationAddressUse (2.0.0) (required)
.... thumbnail 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..1 IVL_TS
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
.... @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: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... modeCode 0..1 CE
.... assignedEntity 1..1 AssignedEntity
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
.... @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 1..1 code Binding: CDAParticipationType (required)
Fixed Value: LOC
.... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... awarenessCode 0..1 CE
.... participantRole S 1..1 ParticipantRole
..... @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
..... @classCode 1..1 code Binding: CDARoleClassRoot (required)
Fixed Value: SDLOC
..... id 0..* II
..... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1 CE Binding: CDARoleCode (example)
..... addr 0..* AD
..... telecom 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity S 1..1 PlayingEntity
...... @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
...... @classCode 1..1 code Binding: EntityClassRoot (required)
Fixed Value: PLC
...... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code 0..1 CE Binding: CDAEntityCode (example)
...... quantity 0..* PQ
...... name S 1..* PN
...... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
...... desc 0..1 ED
..... scopingEntity 0..1 Entity
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
Encounter.moodCoderequiredPattern: PRP
http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0
Encounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Encounter.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Encounter.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Encounter.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Encounter.text.reference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.text.reference.userequiredTelecommunicationAddressUse
http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.performer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeCoderequiredFixed Value: PRF
http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer
Encounter.participant.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.typeCoderequiredFixed Value: LOC
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Encounter.participant.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Encounter.participant.participantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.participantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.participantRole.classCoderequiredFixed Value: SDLOC
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
Encounter.participant.participantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
Encounter.participant.participantRole.playingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.participantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant.participantRole.playingEntity.classCoderequiredFixed Value: PLC
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Encounter.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Encounter.participant.participantRole.playingEntity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

This structure is derived from Encounter

Summary

Mandatory: 5 elements(8 nested mandatory elements)
Must-Support: 8 elements
Fixed: 5 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Encounter.templateId

 

Other representations of profile: CSV, Excel