Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Planned Coverage

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedCoverage Version: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: PlannedCoverage
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.129

This template represents the insurance coverage intended to cover an act or procedure.

Usage:

Formal Views of Profile Content

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

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:planned-coverage 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
..... @extension 0..0
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: INT
... code 1..1CD
.... @code 1..1csRequired Pattern: 48768-6
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: active
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by exists:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... @typeCode 1..1csFixed Value: COMP
..... act 1..1Act
...... @classCode 1..1csFixed Value: ACT
...... @moodCode 1..1csFixed Value: INT
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer Type (required)
...... statusCode 1..1CS
....... @code 1..1csFixed Value: active

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.entryRelationship:entryRelationship1.act.coderequiredPayerType

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:planned-coverage 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: INT
... code 1..1CDBinding: v3 Code System ActCode (example)
.... @code 1..1csRequired Pattern: 48768-6
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by exists:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... act 1..1Act
...... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
...... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: INT
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer Type (required)
...... statusCode 1..1CSBinding: ActStatus (required)
....... @code 1..1csFixed Value: active

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredFixed Value: INT
Act.codeexampleActCode
Act.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: COMP
Act.entryRelationship:entryRelationship1.act.classCoderequiredFixed Value: ACT
Act.entryRelationship:entryRelationship1.act.moodCoderequiredFixed Value: INT
Act.entryRelationship:entryRelationship1.act.coderequiredPayerType
Act.entryRelationship:entryRelationship1.act.statusCoderequiredActStatus

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:planned-coverage 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: INT
... @negationInd 0..1bl
... id 1..*II
... code 1..1CDBinding: v3 Code System ActCode (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csRequired Pattern: 48768-6
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (example)
... languageCode 0..1CSBinding: AllLanguages (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by exists:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1Act
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1st
...... templateId 0..*II
...... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
...... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: INT
...... @negationInd 0..1bl
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer Type (required)
...... text 0..1ED
...... statusCode 1..1CSBinding: ActStatus (required)
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @code 1..1csFixed Value: active
....... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
....... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... effectiveTime 0..1IVL_TS
...... priorityCode 0..1CEBinding: ActPriority (example)
...... languageCode 0..1CSBinding: AllLanguages (required)
...... subject 0..1Subject
...... specimen 0..*Specimen
...... performer 0..*Performer2
...... author 0..*Author
...... informant 0..*Informant
...... participant 0..*Participant2
...... entryRelationship 0..*EntryRelationship
...... reference 0..*Reference
...... precondition 0..*Precondition
...... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
...... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredCDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
Act.templateId:planned-coverage.nullFlavorrequiredCDANullFlavor
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredFixed Value: INT
Act.codeexampleActCode
Act.code.nullFlavorrequiredCDANullFlavor
Act.text.nullFlavorrequiredCDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.mediaTypeexampleMediaType
Act.text.representationrequiredBinaryDataEncoding
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
Act.priorityCodeexampleActPriority
Act.languageCoderequiredAllLanguages
Act.entryRelationship:entryRelationship1.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryRelationship1.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: COMP
Act.entryRelationship:entryRelationship1.act.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryRelationship1.act.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryRelationship1.act.classCoderequiredFixed Value: ACT
Act.entryRelationship:entryRelationship1.act.moodCoderequiredFixed Value: INT
Act.entryRelationship:entryRelationship1.act.coderequiredPayerType
Act.entryRelationship:entryRelationship1.act.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.act.statusCode.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryRelationship1.act.priorityCodeexampleActPriority
Act.entryRelationship:entryRelationship1.act.languageCoderequiredAllLanguages

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Act

Summary

Mandatory: 14 elements
Fixed Value: 7 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root
  • The element Act.entryRelationship is sliced based on the value of exists:act

Differential View

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:planned-coverage 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
..... @extension 0..0
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: INT
... code 1..1CD
.... @code 1..1csRequired Pattern: 48768-6
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: active
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by exists:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... @typeCode 1..1csFixed Value: COMP
..... act 1..1Act
...... @classCode 1..1csFixed Value: ACT
...... @moodCode 1..1csFixed Value: INT
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer Type (required)
...... statusCode 1..1CS
....... @code 1..1csFixed Value: active

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.entryRelationship:entryRelationship1.act.coderequiredPayerType

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:planned-coverage 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: INT
... code 1..1CDBinding: v3 Code System ActCode (example)
.... @code 1..1csRequired Pattern: 48768-6
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by exists:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... act 1..1Act
...... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
...... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: INT
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer Type (required)
...... statusCode 1..1CSBinding: ActStatus (required)
....... @code 1..1csFixed Value: active

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredFixed Value: INT
Act.codeexampleActCode
Act.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: COMP
Act.entryRelationship:entryRelationship1.act.classCoderequiredFixed Value: ACT
Act.entryRelationship:entryRelationship1.act.moodCoderequiredFixed Value: INT
Act.entryRelationship:entryRelationship1.act.coderequiredPayerType
Act.entryRelationship:entryRelationship1.act.statusCoderequiredActStatus

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:planned-coverage 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: INT
... @negationInd 0..1bl
... id 1..*II
... code 1..1CDBinding: v3 Code System ActCode (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csRequired Pattern: 48768-6
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (example)
... languageCode 0..1CSBinding: AllLanguages (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by exists:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1Act
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1st
...... templateId 0..*II
...... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
...... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: INT
...... @negationInd 0..1bl
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer Type (required)
...... text 0..1ED
...... statusCode 1..1CSBinding: ActStatus (required)
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @code 1..1csFixed Value: active
....... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
....... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... effectiveTime 0..1IVL_TS
...... priorityCode 0..1CEBinding: ActPriority (example)
...... languageCode 0..1CSBinding: AllLanguages (required)
...... subject 0..1Subject
...... specimen 0..*Specimen
...... performer 0..*Performer2
...... author 0..*Author
...... informant 0..*Informant
...... participant 0..*Participant2
...... entryRelationship 0..*EntryRelationship
...... reference 0..*Reference
...... precondition 0..*Precondition
...... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
...... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredCDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
Act.templateId:planned-coverage.nullFlavorrequiredCDANullFlavor
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredFixed Value: INT
Act.codeexampleActCode
Act.code.nullFlavorrequiredCDANullFlavor
Act.text.nullFlavorrequiredCDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.mediaTypeexampleMediaType
Act.text.representationrequiredBinaryDataEncoding
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
Act.priorityCodeexampleActPriority
Act.languageCoderequiredAllLanguages
Act.entryRelationship:entryRelationship1.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryRelationship1.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: COMP
Act.entryRelationship:entryRelationship1.act.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryRelationship1.act.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryRelationship1.act.classCoderequiredFixed Value: ACT
Act.entryRelationship:entryRelationship1.act.moodCoderequiredFixed Value: INT
Act.entryRelationship:entryRelationship1.act.coderequiredPayerType
Act.entryRelationship:entryRelationship1.act.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.act.statusCode.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryRelationship1.act.priorityCodeexampleActPriority
Act.entryRelationship:entryRelationship1.act.languageCoderequiredAllLanguages

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Act

Summary

Mandatory: 14 elements
Fixed Value: 7 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root
  • The element Act.entryRelationship is sliced based on the value of exists:act

 

Other representations of profile: CSV, Excel