Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Procedure Activity Act

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.12 Version: 2.1.0-draft1
Active as of 2023-01-16 Computable Name: ProcedureActivityAct
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.12:2014-06-09

This template represents any act that cannot be classified as an observation or procedure according to the HL7 RIM. Examples of these acts are a dressing change, teaching or feeding a patient, or providing comfort measures. The common notion of “procedure” is broader than that specified by the HL7 Version 3 Reference Information Model (RIM). Procedure templates can be represented with various RIM classes: act (e.g., dressing change), observation (e.g., EEG), procedure (e.g., splenectomy).

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.12
..... extension 1..1stringRequired Pattern: 2014-06-09
... code C1..1CD1098-19190: This @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
.... originalText 0..1ED
..... reference 0..1TEL
...... value C0..1uri1098-19189: This reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
... statusCode 1..1CS
.... code 1..1stringBinding: ProcedureAct statusCode (required)
... effectiveTime 1..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (required)
... performer 0..*Performer2
.... assignedEntity 1..1AssignedEntity
..... id 1..*II
..... addr 1..*AD
..... telecom 1..*TEL
..... representedOrganization 0..1Organization
...... id 0..*II
...... name 0..*ON
...... telecom 1..*TEL
...... addr 1..*AD
... author 0..*AuthorParticipationBase for all types and resources
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:location 0..*Participant2
..... typeCode 1..1codeRequired Pattern: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship 0..*ElementSlice: Unordered, Open by profile:encounter, profile:act, profile:observation, profile:substanceAdministration
.... entryRelationship:encounter 0..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 1..1booleanRequired Pattern: true
..... encounter 1..1Encounter
...... classCode 1..1codeRequired Pattern: ENC
...... moodCode 1..1codeRequired Pattern: EVN
...... id C1..1II1098-16849: Set the encounter ID to the ID of an encounter in another section to signify they are the same encounter (CONF:1098-16849).
.... entryRelationship:instruction 0..1Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:indication 0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:medication 0..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... substanceAdministration 1..1MedicationActivityBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.statusCode.coderequiredProcedureAct statusCode
Act.priorityCoderequiredActPriority

Constraints

IdGradePath(s)DetailsRequirements
1098-16849warningAct.entryRelationship:encounter.encounter.idSet the encounter ID to the ID of an encounter in another section to signify they are the same encounter (CONF:1098-16849).
:
1098-19189errorAct.code.originalText.reference.valueThis reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
:
1098-19190warningAct.codeThis @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.12
..... extension 1..1stringRequired Pattern: 2014-06-09
... code C1..1CDBinding: v3 Code System ActCode (extensible)
1098-19190: This @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
.... originalText 0..1ED
..... reference 0..1TEL
...... value C0..1uri1098-19189: This reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringBinding: ProcedureAct statusCode (required)
... effectiveTime 1..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (required)
... performer 0..*Performer2
.... assignedEntity 1..1AssignedEntity
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... id 1..*II
..... addr 1..*AD
..... telecom 1..*TEL
..... representedOrganization 0..1Organization
...... classCode 1..1codeBinding: EntityClassOrganization (required)
Fixed Value: ORG
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... id 0..*II
...... name 0..*ON
...... telecom 1..*TEL
...... addr 1..*AD
... author 0..*AuthorParticipationBase for all types and resources
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:location 0..*Participant2
..... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by profile:encounter, profile:act, profile:observation, profile:substanceAdministration
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:encounter C0..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... encounter 1..1Encounter
.... entryRelationship:instruction C0..1Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:indication C0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... contextConductionInd 1..1boolean
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:medication C0..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... contextConductionInd 1..1boolean
..... substanceAdministration C1..1MedicationActivityBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.codeextensibleActCode
Act.statusCoderequiredActStatus
Act.statusCode.coderequiredProcedureAct statusCode
Act.priorityCoderequiredActPriority
Act.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
Act.performer.assignedEntity.representedOrganization.classCoderequiredFixed Value: ORG
Act.performer.assignedEntity.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
Act.participant:location.typeCoderequiredPattern: LOC

Constraints

IdGradePath(s)DetailsRequirements
1098-19189errorAct.code.originalText.reference.valueThis reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
:
1098-19190warningAct.codeThis @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
:
1098-30800warningAct.entryRelationship:medication.substanceAdministrationMedication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800).
:
act-er-1errorAct.entryRelationship, Act.entryRelationship:encounter, Act.entryRelationship:instruction, Act.entryRelationship:indication, Act.entryRelationship:medicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: EVN
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.12
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 1..*II
... code C1..1CDBinding: v3 Code System ActCode (extensible)
1098-19190: This @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1string
.... codeSystem 0..1string
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... charset 0..1code
..... compression 0..1codeBinding: CompressionAlgorithm (required)
..... integrityCheck 0..1base64Binary
..... integrityCheckAlgorithm 0..1codeBinding: IntegrityCheckAlgorithm (required)
..... language 0..1code
..... mediaType 0..1code
..... representation 0..1code
..... data[x] 0..1
...... dataStringstring
...... dataBase64Binarybase64Binary
..... reference 0..1TEL
...... nullFlavor 0..1codeBinding: NullFlavor (required)
...... value C0..1uri1098-19189: This reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
...... useablePeriod 0..*
....... useablePeriodIVL_TS
....... useablePeriodEIVL_TS
....... useablePeriodPIVL_TS
....... useablePeriodSXPR_TS
...... use 0..*codeBinding: AddressUse (required)
..... thumbnail 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... negationInd 0..1boolean
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringBinding: ProcedureAct statusCode (required)
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (required)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 0..1csBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
.... time 0..1IVL_TS
.... modeCode 0..1CE
.... assignedEntity 1..1AssignedEntity
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... id 1..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr 1..*AD
..... telecom 1..*TEL
..... assignedPerson 0..1Person
..... representedOrganization 0..1Organization
...... classCode 1..1codeBinding: EntityClassOrganization (required)
Fixed Value: ORG
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... id 0..*II
...... name 0..*ON
...... telecom 1..*TEL
...... addr 1..*AD
...... standardIndustryClassCode 0..1CEBinding: OrganizationIndustryClassNAICS (extensible)
...... asOrganizationPartOf 0..1OrganizationPartOf
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:location 0..*Participant2
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: LOC
..... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by profile:encounter, profile:act, profile:observation, profile:substanceAdministration
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:encounter C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... encounter 1..1Encounter
.... entryRelationship:instruction C0..1Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:indication C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:medication C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... substanceAdministration C1..1MedicationActivityBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.code.originalText.nullFlavorrequiredNullFlavor
Act.code.originalText.compressionrequiredCompressionAlgorithm
Act.code.originalText.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.code.originalText.reference.nullFlavorrequiredNullFlavor
Act.code.originalText.reference.userequiredAddressUse
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredNullFlavor
Act.statusCode.coderequiredProcedureAct statusCode
Act.priorityCoderequiredActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.subject.typeCoderequiredFixed Value: SBJ
Act.subject.contextControlCoderequiredFixed Value: OP
Act.subject.awarenessCodeextensibleTargetAwareness
Act.performer.nullFlavorrequiredNullFlavor
Act.performer.typeCoderequiredFixed Value: PRF
Act.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
Act.performer.assignedEntity.codeextensibleRoleCode
Act.performer.assignedEntity.representedOrganization.classCoderequiredFixed Value: ORG
Act.performer.assignedEntity.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
Act.performer.assignedEntity.representedOrganization.standardIndustryClassCodeextensibleOrganizationIndustryClassNAICS
Act.informant.typeCoderequiredFixed Value: INF
Act.informant.contextControlCoderequiredFixed Value: OP
Act.participant:location.nullFlavorrequiredNullFlavor
Act.participant:location.typeCoderequiredPattern: LOC
Act.participant:location.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
1098-19189errorAct.code.originalText.reference.valueThis reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
:
1098-19190warningAct.codeThis @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
:
1098-30800warningAct.entryRelationship:medication.substanceAdministrationMedication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800).
:
act-er-1errorAct.entryRelationship, Act.entryRelationship:encounter, Act.entryRelationship:instruction, Act.entryRelationship:indication, Act.entryRelationship:medicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CDAR2.Act

Cannot invoke "org.hl7.fhir.r5.model.ElementDefinition.getPath()" because "match" is null

Differential View

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.12
..... extension 1..1stringRequired Pattern: 2014-06-09
... code C1..1CD1098-19190: This @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
.... originalText 0..1ED
..... reference 0..1TEL
...... value C0..1uri1098-19189: This reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
... statusCode 1..1CS
.... code 1..1stringBinding: ProcedureAct statusCode (required)
... effectiveTime 1..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (required)
... performer 0..*Performer2
.... assignedEntity 1..1AssignedEntity
..... id 1..*II
..... addr 1..*AD
..... telecom 1..*TEL
..... representedOrganization 0..1Organization
...... id 0..*II
...... name 0..*ON
...... telecom 1..*TEL
...... addr 1..*AD
... author 0..*AuthorParticipationBase for all types and resources
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:location 0..*Participant2
..... typeCode 1..1codeRequired Pattern: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship 0..*ElementSlice: Unordered, Open by profile:encounter, profile:act, profile:observation, profile:substanceAdministration
.... entryRelationship:encounter 0..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 1..1booleanRequired Pattern: true
..... encounter 1..1Encounter
...... classCode 1..1codeRequired Pattern: ENC
...... moodCode 1..1codeRequired Pattern: EVN
...... id C1..1II1098-16849: Set the encounter ID to the ID of an encounter in another section to signify they are the same encounter (CONF:1098-16849).
.... entryRelationship:instruction 0..1Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:indication 0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:medication 0..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... substanceAdministration 1..1MedicationActivityBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.statusCode.coderequiredProcedureAct statusCode
Act.priorityCoderequiredActPriority

Constraints

IdGradePath(s)DetailsRequirements
1098-16849warningAct.entryRelationship:encounter.encounter.idSet the encounter ID to the ID of an encounter in another section to signify they are the same encounter (CONF:1098-16849).
:
1098-19189errorAct.code.originalText.reference.valueThis reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
:
1098-19190warningAct.codeThis @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.12
..... extension 1..1stringRequired Pattern: 2014-06-09
... code C1..1CDBinding: v3 Code System ActCode (extensible)
1098-19190: This @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
.... originalText 0..1ED
..... reference 0..1TEL
...... value C0..1uri1098-19189: This reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringBinding: ProcedureAct statusCode (required)
... effectiveTime 1..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (required)
... performer 0..*Performer2
.... assignedEntity 1..1AssignedEntity
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... id 1..*II
..... addr 1..*AD
..... telecom 1..*TEL
..... representedOrganization 0..1Organization
...... classCode 1..1codeBinding: EntityClassOrganization (required)
Fixed Value: ORG
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... id 0..*II
...... name 0..*ON
...... telecom 1..*TEL
...... addr 1..*AD
... author 0..*AuthorParticipationBase for all types and resources
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:location 0..*Participant2
..... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by profile:encounter, profile:act, profile:observation, profile:substanceAdministration
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:encounter C0..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... encounter 1..1Encounter
.... entryRelationship:instruction C0..1Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:indication C0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... contextConductionInd 1..1boolean
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:medication C0..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... contextConductionInd 1..1boolean
..... substanceAdministration C1..1MedicationActivityBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.codeextensibleActCode
Act.statusCoderequiredActStatus
Act.statusCode.coderequiredProcedureAct statusCode
Act.priorityCoderequiredActPriority
Act.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
Act.performer.assignedEntity.representedOrganization.classCoderequiredFixed Value: ORG
Act.performer.assignedEntity.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
Act.participant:location.typeCoderequiredPattern: LOC

Constraints

IdGradePath(s)DetailsRequirements
1098-19189errorAct.code.originalText.reference.valueThis reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
:
1098-19190warningAct.codeThis @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
:
1098-30800warningAct.entryRelationship:medication.substanceAdministrationMedication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800).
:
act-er-1errorAct.entryRelationship, Act.entryRelationship:encounter, Act.entryRelationship:instruction, Act.entryRelationship:indication, Act.entryRelationship:medicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: EVN
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.12
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 1..*II
... code C1..1CDBinding: v3 Code System ActCode (extensible)
1098-19190: This @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1string
.... codeSystem 0..1string
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... charset 0..1code
..... compression 0..1codeBinding: CompressionAlgorithm (required)
..... integrityCheck 0..1base64Binary
..... integrityCheckAlgorithm 0..1codeBinding: IntegrityCheckAlgorithm (required)
..... language 0..1code
..... mediaType 0..1code
..... representation 0..1code
..... data[x] 0..1
...... dataStringstring
...... dataBase64Binarybase64Binary
..... reference 0..1TEL
...... nullFlavor 0..1codeBinding: NullFlavor (required)
...... value C0..1uri1098-19189: This reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
...... useablePeriod 0..*
....... useablePeriodIVL_TS
....... useablePeriodEIVL_TS
....... useablePeriodPIVL_TS
....... useablePeriodSXPR_TS
...... use 0..*codeBinding: AddressUse (required)
..... thumbnail 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... negationInd 0..1boolean
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringBinding: ProcedureAct statusCode (required)
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (required)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 0..1csBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
.... time 0..1IVL_TS
.... modeCode 0..1CE
.... assignedEntity 1..1AssignedEntity
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... id 1..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr 1..*AD
..... telecom 1..*TEL
..... assignedPerson 0..1Person
..... representedOrganization 0..1Organization
...... classCode 1..1codeBinding: EntityClassOrganization (required)
Fixed Value: ORG
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... id 0..*II
...... name 0..*ON
...... telecom 1..*TEL
...... addr 1..*AD
...... standardIndustryClassCode 0..1CEBinding: OrganizationIndustryClassNAICS (extensible)
...... asOrganizationPartOf 0..1OrganizationPartOf
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:location 0..*Participant2
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: LOC
..... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by profile:encounter, profile:act, profile:observation, profile:substanceAdministration
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:encounter C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... encounter 1..1Encounter
.... entryRelationship:instruction C0..1Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:indication C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:medication C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... substanceAdministration C1..1MedicationActivityBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.code.originalText.nullFlavorrequiredNullFlavor
Act.code.originalText.compressionrequiredCompressionAlgorithm
Act.code.originalText.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.code.originalText.reference.nullFlavorrequiredNullFlavor
Act.code.originalText.reference.userequiredAddressUse
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredNullFlavor
Act.statusCode.coderequiredProcedureAct statusCode
Act.priorityCoderequiredActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.subject.typeCoderequiredFixed Value: SBJ
Act.subject.contextControlCoderequiredFixed Value: OP
Act.subject.awarenessCodeextensibleTargetAwareness
Act.performer.nullFlavorrequiredNullFlavor
Act.performer.typeCoderequiredFixed Value: PRF
Act.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
Act.performer.assignedEntity.codeextensibleRoleCode
Act.performer.assignedEntity.representedOrganization.classCoderequiredFixed Value: ORG
Act.performer.assignedEntity.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
Act.performer.assignedEntity.representedOrganization.standardIndustryClassCodeextensibleOrganizationIndustryClassNAICS
Act.informant.typeCoderequiredFixed Value: INF
Act.informant.contextControlCoderequiredFixed Value: OP
Act.participant:location.nullFlavorrequiredNullFlavor
Act.participant:location.typeCoderequiredPattern: LOC
Act.participant:location.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
1098-19189errorAct.code.originalText.reference.valueThis reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-19189).
:
1098-19190warningAct.codeThis @code **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96), and **MAY** be selected from CPT-4 (CodeSystem: 2.16.840.1.113883.6.12) or ICD10 PCS (CodeSystem: 2.16.840.1.113883.6.4) or CDT-2 (Code System: 2.16.840.1.113883.6.13) (CONF:1098-19190).
:
1098-30800warningAct.entryRelationship:medication.substanceAdministrationMedication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800).
:
act-er-1errorAct.entryRelationship, Act.entryRelationship:encounter, Act.entryRelationship:instruction, Act.entryRelationship:indication, Act.entryRelationship:medicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CDAR2.Act

Cannot invoke "org.hl7.fhir.r5.model.ElementDefinition.getPath()" because "match" is null

 

​Other representations of profile: CSV, Excel, Schematron