Consolidated CDA (C-CDA)
3.0.0 - STU3
Consolidated CDA (C-CDA)
3.0.0 - STU3
This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationsSection | Version: 3.0.0 | |||
| Draft as of 2024-05-18 | Computable Name: MedicationsSection | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.2.1.1:2014-06-09 | ||||
The Medications Section contains a patient’s current medications and pertinent medication history. At a minimum, the currently active medications are listed. An entire medication history is an option. The section can describe a patient’s prescription and dispense history and information about intended drug monitoring.
This section requires either an entry indicating the subject is not known to be on any medications or entries summarizing the subject’s medications.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Section
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Section |
C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) shall-med-activity: If section/@nullFlavor is not present, SHALL contain at least one Medication Activity |
 @nullFlavor |
0..1 | cs | If a required section contains no information, the @nullFlavor MAY be set to NI | |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:section |
1..1 | II | ||
  @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.1.1 | |
  @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| code |
1..1 | CE | History of Medication use Narrative | |
| @code |
1..1 | cs | Required Pattern: 10160-0 | |
 @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| title |
1..1 | ST | ||
| text |
1..1 | xhtml | ||
 Slices for entry |
0..* | Entry | If section/@nullFlavor is not present: Slice: Unordered, Open by profile:substanceAdministration | |
| entry:medActivity |
0..* | Entry | ||
 substanceAdministration |
1..1 | MedicationActivity | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| shall-med-activity | error | Section | If section/@nullFlavor is not present, SHALL contain at least one Medication Activity : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/MedicationActivity')).exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section |
C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) shall-med-activity: If section/@nullFlavor is not present, SHALL contain at least one Medication Activity |
 @nullFlavor |
0..1 | cs | If a required section contains no information, the @nullFlavor MAY be set to NI Binding: CDANullFlavor (required) | |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:section |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| code |
1..1 | CE | History of Medication use Narrative Binding: DocumentSectionType (example) | |
| @code |
1..1 | cs | Required Pattern: 10160-0 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| title |
1..1 | ST | ||
| text |
1..1 | xhtml | ||
| Slices for entry |
0..* | Entry | If section/@nullFlavor is not present: Slice: Unordered, Open by profile:substanceAdministration | |
| entry:medActivity |
0..* | Entry | ||
| substanceAdministration |
C | 1..1 | MedicationActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value 1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). should-routeCode: SHOULD contain routeCode dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. should-author: SHOULD contain author |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-7513 | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). : effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists() | |
| dose-unit-or-admin-unit | error | Section.entry:medActivity.substanceAdministration | If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. : doseQuantity.unit.exists() implies administrationUnitCode.empty() | |
| shall-med-activity | error | Section | If section/@nullFlavor is not present, SHALL contain at least one Medication Activity : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/MedicationActivity')).exists() | |
| should-author | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain author : author.exists() | |
| should-routeCode | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain routeCode : routeCode.exists() | |
| should-text-ref-value | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain text/reference/@value : text.reference.value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section |
C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) shall-med-activity: If section/@nullFlavor is not present, SHALL contain at least one Medication Activity |
| @nullFlavor |
0..1 | cs | If a required section contains no information, the @nullFlavor MAY be set to NI Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:section |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| @ID |
0..1 | xs:ID | ||
| @classCode |
0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..1 | II | ||
| code |
1..1 | CE | History of Medication use Narrative Binding: DocumentSectionType (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 10160-0 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| title |
1..1 | ST | ||
| text |
1..1 | xhtml | ||
| confidentialityCode |
0..1 | CE | ||
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for entry |
0..* | Entry | If section/@nullFlavor is not present: Slice: Unordered, Open by profile:substanceAdministration | |
| entry:medActivity |
0..* | Entry | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
 typeId |
0..1 | II | ||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
C | 1..1 | MedicationActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value 1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). should-routeCode: SHOULD contain routeCode dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. should-author: SHOULD contain author |
| supply |
0..1 | Supply | ||
| component |
0..* | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Fixed Value: COMP | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| section |
1..1 | Section | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.templateId:section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.classCode | required | Fixed Value: DOCSECThttp://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer | |
| Section.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType | |
| Section.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Section.entry:medActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:medActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:medActivity.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
| Section.component.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.component.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-7513 | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). : effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists() | |
| dose-unit-or-admin-unit | error | Section.entry:medActivity.substanceAdministration | If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. : doseQuantity.unit.exists() implies administrationUnitCode.empty() | |
| shall-med-activity | error | Section | If section/@nullFlavor is not present, SHALL contain at least one Medication Activity : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/MedicationActivity')).exists() | |
| should-author | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain author : author.exists() | |
| should-routeCode | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain routeCode : routeCode.exists() | |
| should-text-ref-value | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain text/reference/@value : text.reference.value.exists() |
This structure is derived from Section
Summary
Mandatory: 9 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Section
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section |
C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) shall-med-activity: If section/@nullFlavor is not present, SHALL contain at least one Medication Activity |
| @nullFlavor |
0..1 | cs | If a required section contains no information, the @nullFlavor MAY be set to NI | |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:section |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| code |
1..1 | CE | History of Medication use Narrative | |
| @code |
1..1 | cs | Required Pattern: 10160-0 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| title |
1..1 | ST | ||
| text |
1..1 | xhtml | ||
| Slices for entry |
0..* | Entry | If section/@nullFlavor is not present: Slice: Unordered, Open by profile:substanceAdministration | |
| entry:medActivity |
0..* | Entry | ||
| substanceAdministration |
1..1 | MedicationActivity | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| shall-med-activity | error | Section | If section/@nullFlavor is not present, SHALL contain at least one Medication Activity : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/MedicationActivity')).exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section |
C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) shall-med-activity: If section/@nullFlavor is not present, SHALL contain at least one Medication Activity |
| @nullFlavor |
0..1 | cs | If a required section contains no information, the @nullFlavor MAY be set to NI Binding: CDANullFlavor (required) | |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:section |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| code |
1..1 | CE | History of Medication use Narrative Binding: DocumentSectionType (example) | |
| @code |
1..1 | cs | Required Pattern: 10160-0 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| title |
1..1 | ST | ||
| text |
1..1 | xhtml | ||
| Slices for entry |
0..* | Entry | If section/@nullFlavor is not present: Slice: Unordered, Open by profile:substanceAdministration | |
| entry:medActivity |
0..* | Entry | ||
| substanceAdministration |
C | 1..1 | MedicationActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value 1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). should-routeCode: SHOULD contain routeCode dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. should-author: SHOULD contain author |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-7513 | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). : effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists() | |
| dose-unit-or-admin-unit | error | Section.entry:medActivity.substanceAdministration | If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. : doseQuantity.unit.exists() implies administrationUnitCode.empty() | |
| shall-med-activity | error | Section | If section/@nullFlavor is not present, SHALL contain at least one Medication Activity : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/MedicationActivity')).exists() | |
| should-author | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain author : author.exists() | |
| should-routeCode | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain routeCode : routeCode.exists() | |
| should-text-ref-value | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain text/reference/@value : text.reference.value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section |
C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) shall-med-activity: If section/@nullFlavor is not present, SHALL contain at least one Medication Activity |
| @nullFlavor |
0..1 | cs | If a required section contains no information, the @nullFlavor MAY be set to NI Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:section |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| @ID |
0..1 | xs:ID | ||
| @classCode |
0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..1 | II | ||
| code |
1..1 | CE | History of Medication use Narrative Binding: DocumentSectionType (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 10160-0 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| title |
1..1 | ST | ||
| text |
1..1 | xhtml | ||
| confidentialityCode |
0..1 | CE | ||
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for entry |
0..* | Entry | If section/@nullFlavor is not present: Slice: Unordered, Open by profile:substanceAdministration | |
| entry:medActivity |
0..* | Entry | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
C | 1..1 | MedicationActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value 1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). should-routeCode: SHOULD contain routeCode dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. should-author: SHOULD contain author |
| supply |
0..1 | Supply | ||
| component |
0..* | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Fixed Value: COMP | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| section |
1..1 | Section | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.templateId:section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.classCode | required | Fixed Value: DOCSECThttp://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer | |
| Section.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType | |
| Section.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Section.entry:medActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:medActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:medActivity.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
| Section.component.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.component.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-7513 | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). : effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists() | |
| dose-unit-or-admin-unit | error | Section.entry:medActivity.substanceAdministration | If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. : doseQuantity.unit.exists() implies administrationUnitCode.empty() | |
| shall-med-activity | error | Section | If section/@nullFlavor is not present, SHALL contain at least one Medication Activity : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/MedicationActivity')).exists() | |
| should-author | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain author : author.exists() | |
| should-routeCode | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain routeCode : routeCode.exists() | |
| should-text-ref-value | warning | Section.entry:medActivity.substanceAdministration | SHOULD contain text/reference/@value : text.reference.value.exists() |
This structure is derived from Section
Summary
Mandatory: 9 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0 based on FHIR 5.0.0. Generated 2024-05-18
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change