PlannedMedicationActivity
type: StructureDefinition
node role: treeRoot
id:
  v: PlannedMedicationActivity
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition PlannedMedicationActivity Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> SubstanceAdministration <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( should-text-ref-value, dose-unit-or-admin-unit, should-author )">C 1..1 SubstanceAdministration XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, dose-unit-or-admin-unit, should-author #xD; Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension #xD; templateId:planned-med-activity 1..1 II #xD; @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.42 #xD; @extension 1..1 st Required Pattern: 2014-06-09 #xD; @classCode 1..1 cs #xD; @moodCode 1..1 cs Binding: Planned moodCode (SubstanceAdministration/Supply) (required) #xD; id 1..* II #xD; text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry #xD; reference <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( value-starts-octothorpe )">C 0..1 TEL Constraints: value-starts-octothorpe #xD; statusCode 1..1 CS #xD; @code 1..1 cs Fixed Value: active #xD; Slices for effectiveTime 1..…
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
    l: logical-target
  value: Boolean
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        l: data-absent-reason
      value: Code
        v: not-applicable
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:v3
    l: v3
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: substanceAdministration
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-container
    l: logical-container
  value: Uri
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
    l: ClinicalDocument
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/type-profile-style
    l: type-profile-style
  value: Code
    v: cda
url:
  v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
  l: PlannedMedicationActivity
identifier:
  system:
    v: urn:ietf:rfc:3986
    l: 3986
  value:
    v: urn:hl7ii:2.16.840.1.113883.10.20.22.4.42:2014-06-09
version:
  v: 4.0.0
name:
  v: PlannedMedicationActivity
title:
  v: Planned Medication Activity
status:
  v: draft
date:
  v: 2025-11-06T00:43:30+00:00
publisher:
  v: Health Level Seven
contact:
  name:
    v: HL7 International - Structured Documents
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/structure
description:
  v: This template represents planned medication activities. The priority of the medication activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the medication activity is intended to take place. The authorTime indicates when the documentation of the plan occurred. #### Templates Used Although open templates may contain any valid CDA content, the following templates are specifically called out by this template: **Optional EntryRelationships**: [Indication](StructureDefinition-Indication.html), [InstructionObservation](StructureDefinition-InstructionObservation.html), [PriorityPreference](StructureDefinition-PriorityPreference.html)
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: US
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
  l: SubstanceAdministration
base definition:
  v: http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
  l: SubstanceAdministration
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 2.0.1-sd
  element:
    id:
      v: SubstanceAdministration
    path:
      v: SubstanceAdministration
    short:
      v: Base for all types and resources
    definition:
      v: Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: should-text-ref-value
      severity:
        v: warning
      human:
        v: SHOULD contain text/reference/@value
      expression:
        v: text.reference.value.exists()
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
        l: PlannedMedicationActivity
    constraint:
      key:
        v: dose-unit-or-admin-unit
      severity:
        v: error
      human:
        v: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
      expression:
        v: doseQuantity.unit.exists() implies administrationUnitCode.empty()
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
        l: PlannedMedicationActivity
    constraint:
      key:
        v: should-author
      severity:
        v: warning
      human:
        v: SHOULD contain author
      expression:
        v: author.exists()
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
        l: PlannedMedicationActivity
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: SubstanceAdministration.nullFlavor
    path:
      v: SubstanceAdministration.nullFlavor
    representation:
      v: xmlAttr
    label:
      v: Exceptional Value Detail
    definition:
      v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ANY.nullFlavor
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: code
        l: code
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
        l: cs-simple

strength:
  v: required
value set:
  v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
  l: CDANullFlavor

id:
  v: SubstanceAdministration.realmCode
path:
  v: SubstanceAdministration.realmCode
definition:
  v: When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: SubstanceAdministration.typeId
path:
  v: SubstanceAdministration.typeId
definition:
  v: When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: SubstanceAdministration.typeId.nullFlavor
path:
  v: SubstanceAdministration.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.typeId.assigningAuthorityName
path:
  v: SubstanceAdministration.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.typeId.displayable
path:
  v: SubstanceAdministration.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.typeId.root
path:
  v: SubstanceAdministration.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: SubstanceAdministration.typeId.extension
path:
  v: SubstanceAdministration.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.templateId
path:
  v: SubstanceAdministration.templateId
slicing:
  discriminator:
    type:
      v: value
    path:
      v: root
  discriminator:
    type:
      v: value
    path:
      v: extension
  rules:
    v: open
definition:
  v: When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
min:
  v: 1
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: SubstanceAdministration.templateId:planned-med-activity
path:
  v: SubstanceAdministration.templateId
slice name:
  v: planned-med-activity
definition:
  v: When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
min:
  v: 1
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: SubstanceAdministration.templateId:planned-med-activity.nullFlavor
path:
  v: SubstanceAdministration.templateId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.templateId:planned-med-activity.assigningAuthorityName
path:
  v: SubstanceAdministration.templateId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.templateId:planned-med-activity.displayable
path:
  v: SubstanceAdministration.templateId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.templateId:planned-med-activity.root
path:
  v: SubstanceAdministration.templateId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
pattern: String
  v: 2.16.840.1.113883.10.20.22.4.42

id:
  v: SubstanceAdministration.templateId:planned-med-activity.extension
path:
  v: SubstanceAdministration.templateId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple
pattern: String
  v: 2014-06-09

id:
  v: SubstanceAdministration.classCode
path:
  v: SubstanceAdministration.classCode
representation:
  v: xmlAttr
comment:
  v: SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8572).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.classCode
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: SBADM
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDAActClass
    l: CDAActClass

id:
  v: SubstanceAdministration.moodCode
path:
  v: SubstanceAdministration.moodCode
representation:
  v: xmlAttr
comment:
  v: SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8573).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.moodCode
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24

id:
  v: SubstanceAdministration.id
path:
  v: SubstanceAdministration.id
comment:
  v: SHALL contain at least one [1..*] id (CONF:1098-8575).
min:
  v: 1
max:
  v: *
base:
  path:
    v: SubstanceAdministration.id
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: SubstanceAdministration.code
path:
  v: SubstanceAdministration.code
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CD
    l: CD
binding:
  strength:
    v: example
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode
    l: CDAActSubstanceAdministrationCode

id:
  v: SubstanceAdministration.negationInd
path:
  v: SubstanceAdministration.negationInd
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.negationInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.text
path:
  v: SubstanceAdministration.text
short:
  v: SHOULD reference the portion of section narrative text corresponding to this entry
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: SubstanceAdministration.text.nullFlavor
path:
  v: SubstanceAdministration.text.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.text.compression
path:
  v: SubstanceAdministration.text.compression
representation:
  v: xmlAttr
label:
  v: Compression
definition:
  v: Indicates whether the raw byte data is compressed, and what compression algorithm was used.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.compression
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
    l: CDACompressionAlgorithm

id:
  v: SubstanceAdministration.text.integrityCheck
path:
  v: SubstanceAdministration.text.integrityCheck
representation:
  v: xmlAttr
label:
  v: Integrity Check
definition:
  v: The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.integrityCheck
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
    l: base64Binary
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bin
    l: bin

id:
  v: SubstanceAdministration.text.integrityCheckAlgorithm
path:
  v: SubstanceAdministration.text.integrityCheckAlgorithm
representation:
  v: xmlAttr
label:
  v: Integrity Check Algorithm
definition:
  v: Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.integrityCheckAlgorithm
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
    l: http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm

id:
  v: SubstanceAdministration.text.language
path:
  v: SubstanceAdministration.text.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: SubstanceAdministration.text.mediaType
path:
  v: SubstanceAdministration.text.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: example
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-MediaType
    l: v3-MediaType

id:
  v: SubstanceAdministration.text.representation
path:
  v: SubstanceAdministration.text.representation
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
    l: BinaryDataEncoding

id:
  v: SubstanceAdministration.text.xmlText
path:
  v: SubstanceAdministration.text.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
definition:
  v: Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.text.reference
path:
  v: SubstanceAdministration.text.reference
label:
  v: Reference
definition:
  v: A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.reference
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/TEL
    l: TEL
constraint:
  key:
    v: value-starts-octothorpe
  severity:
    v: error
  human:
    v: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
  expression:
    v: value.exists() implies value.startsWith('#')
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
    l: PlannedMedicationActivity

id:
  v: SubstanceAdministration.text.thumbnail
path:
  v: SubstanceAdministration.text.thumbnail
label:
  v: Thumbnail
definition:
  v: An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.thumbnail
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: SubstanceAdministration.statusCode
path:
  v: SubstanceAdministration.statusCode
comment:
  v: SHALL contain exactly one [1..1] statusCode (CONF:1098-32087).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.statusCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-ActStatus
    l: v3-ActStatus

id:
  v: SubstanceAdministration.statusCode.nullFlavor
path:
  v: SubstanceAdministration.statusCode.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.statusCode.code
path:
  v: SubstanceAdministration.statusCode.code
representation:
  v: xmlAttr
label:
  v: Code
definition:
  v: The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
comment:
  v: This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32088).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CD.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: active

id:
  v: SubstanceAdministration.statusCode.codeSystem
path:
  v: SubstanceAdministration.statusCode.codeSystem
representation:
  v: xmlAttr
label:
  v: Code System
definition:
  v: Specifies the code system that defines the code.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.codeSystem
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid

id:
  v: SubstanceAdministration.statusCode.codeSystemName
path:
  v: SubstanceAdministration.statusCode.codeSystemName
representation:
  v: xmlAttr
label:
  v: Code System Name
definition:
  v: The common name of the coding system.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.codeSystemName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.statusCode.codeSystemVersion
path:
  v: SubstanceAdministration.statusCode.codeSystemVersion
representation:
  v: xmlAttr
label:
  v: Code System Version
definition:
  v: If applicable, a version descriptor defined specifically for the given code system.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.codeSystemVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.statusCode.displayName
path:
  v: SubstanceAdministration.statusCode.displayName
representation:
  v: xmlAttr
label:
  v: Display Name
definition:
  v: A name or title for the code, under which the sending system shows the code value to its users.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.displayName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.statusCode.sdtcValueSet
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSet
path:
  v: SubstanceAdministration.statusCode.sdtcValueSet
representation:
  v: xmlAttr
definition:
  v: The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.valueSet
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid

id:
  v: SubstanceAdministration.statusCode.sdtcValueSetVersion
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSetVersion
path:
  v: SubstanceAdministration.statusCode.sdtcValueSetVersion
representation:
  v: xmlAttr
definition:
  v: The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.sdtcValueSetVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.statusCode.originalText
path:
  v: SubstanceAdministration.statusCode.originalText
label:
  v: Original Text
definition:
  v: The text or phrase used as the basis for the coding.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.originalText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: SubstanceAdministration.statusCode.qualifier
path:
  v: SubstanceAdministration.statusCode.qualifier
label:
  v: Qualifier
definition:
  v: Specifies additional codes that increase the specificity of the the primary code.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CR
    l: CR

id:
  v: SubstanceAdministration.statusCode.translation
path:
  v: SubstanceAdministration.statusCode.translation
representation:
  v: typeAttr
label:
  v: Translation
definition:
  v: A set of other concept descriptors that translate this concept descriptor into other code systems.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.translation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CD
    l: CD

id:
  v: SubstanceAdministration.effectiveTime
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype
    l: elementdefinition-defaulttype
  value: Canonical
    v: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
    l: SXCM-TS
path:
  v: SubstanceAdministration.effectiveTime
representation:
  v: typeAttr
slicing:
  discriminator:
    type:
      v: type
    path:
      v: $this
  rules:
    v: open
min:
  v: 1
max:
  v: *
base:
  path:
    v: SubstanceAdministration.effectiveTime
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
    l: SXCM-TS
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
    l: IVL-TS
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS
    l: EIVL-TS
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS
    l: PIVL-TS
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    l: SXPR-TS

id:
  v: SubstanceAdministration.effectiveTime:duration
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype
    l: elementdefinition-defaulttype
  value: Canonical
    v: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
    l: SXCM-TS
path:
  v: SubstanceAdministration.effectiveTime
representation:
  v: typeAttr
slice name:
  v: duration
short:
  v: The effectiveTime in a planned medication activity represents the time that the medication activity should occur.
comment:
  v: SHALL contain exactly one [1..1] effectiveTime (CONF:1098-30468) such that it
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.effectiveTime
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
    l: IVL-TS
constraint:
  key:
    v: 1098-32890
  severity:
    v: error
  human:
    v: This effectiveTime **SHALL** contain either a low or a @value but not both (CONF:1098-32890).
  expression:
    v: (value.exists() or low.exists()) and ((value.exists() and low.exists()).not())
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
    l: PlannedMedicationActivity
constraint:
  key:
    v: should-value-att
  severity:
    v: warning
  human:
    v: SHOULD contain @value
  expression:
    v: value.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
    l: PlannedMedicationActivity
constraint:
  key:
    v: should-low
  severity:
    v: warning
  human:
    v: SHOULD contain low
  expression:
    v: low.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
    l: PlannedMedicationActivity

id:
  v: SubstanceAdministration.effectiveTime:duration.nullFlavor
path:
  v: SubstanceAdministration.effectiveTime.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.effectiveTime:duration.value
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format
    l: elementdefinition-date-format
  value: String
    v: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules
    l: elementdefinition-date-rules
  value: String
    v: year-valid
path:
  v: SubstanceAdministration.effectiveTime.value
representation:
  v: xmlAttr
short:
  v: indicates a single-administration timestamp
definition:
  v: A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
comment:
  v: SHOULD contain zero or one [0..1] @value (CONF:1098-32775).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: TS.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ts-simple
    l: ts-simple

id:
  v: SubstanceAdministration.effectiveTime:duration.operator
path:
  v: SubstanceAdministration.effectiveTime.operator
representation:
  v: xmlAttr
definition:
  v: A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SXCM_TS.operator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
default value: Code
  v: I
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
    l: CDASetOperator

id:
  v: SubstanceAdministration.effectiveTime:duration.low
path:
  v: SubstanceAdministration.effectiveTime.low
label:
  v: Low Boundary
short:
  v: indicates when medication started
definition:
  v: This is the low limit of the interval.
comment:
  v: SHOULD contain zero or one [0..1] low (CONF:1098-32776).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_TS.low
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
    l: IVXB-TS

id:
  v: SubstanceAdministration.effectiveTime:duration.center
path:
  v: SubstanceAdministration.effectiveTime.center
label:
  v: Central Value
definition:
  v: The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_TS.center
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/TS
    l: TS

id:
  v: SubstanceAdministration.effectiveTime:duration.width
path:
  v: SubstanceAdministration.effectiveTime.width
label:
  v: Width
definition:
  v: The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_TS.width
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PQ
    l: PQ

id:
  v: SubstanceAdministration.effectiveTime:duration.high
path:
  v: SubstanceAdministration.effectiveTime.high
label:
  v: High Boundary
short:
  v: indicates when medication stopped
definition:
  v: This is the high limit of the interval.
comment:
  v: MAY contain zero or one [0..1] high (CONF:1098-32777).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_TS.high
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
    l: IVXB-TS

id:
  v: SubstanceAdministration.effectiveTime:periodicFrequency
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype
    l: elementdefinition-defaulttype
  value: Canonical
    v: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
    l: SXCM-TS
path:
  v: SubstanceAdministration.effectiveTime
representation:
  v: typeAttr
slice name:
  v: periodicFrequency
short:
  v: This effectiveTime represents a periodic medication frequency (e.g., administration times per day).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.effectiveTime
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS
    l: EIVL-TS

id:
  v: SubstanceAdministration.effectiveTime:periodicFrequency.nullFlavor
path:
  v: SubstanceAdministration.effectiveTime.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.effectiveTime:periodicFrequency.value
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format
    l: elementdefinition-date-format
  value: String
    v: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules
    l: elementdefinition-date-rules
  value: String
    v: year-valid
path:
  v: SubstanceAdministration.effectiveTime.value
representation:
  v: xmlAttr
definition:
  v: A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: TS.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ts-simple
    l: ts-simple

id:
  v: SubstanceAdministration.effectiveTime:periodicFrequency.operator
path:
  v: SubstanceAdministration.effectiveTime.operator
representation:
  v: xmlAttr
definition:
  v: A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.
comment:
  v: SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SXCM_TS.operator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
default value: Code
  v: I
pattern: Code
  v: A
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
    l: CDASetOperator

id:
  v: SubstanceAdministration.effectiveTime:periodicFrequency.event
path:
  v: SubstanceAdministration.effectiveTime.event
label:
  v: Event
definition:
  v: A code for a common (periodical) activity of daily living based on which the event related periodic interval is specified.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EIVL_TS.event
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE

id:
  v: SubstanceAdministration.effectiveTime:periodicFrequency.offset
path:
  v: SubstanceAdministration.effectiveTime.offset
label:
  v: Offset
definition:
  v: An interval of elapsed time (duration, not absolute point in time) that marks the offsets for the beginning, width and end of the event-related periodic interval measured from the time each such event actually occurred.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EIVL_TS.offset
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
    l: IVL-PQ

id:
  v: SubstanceAdministration.effectiveTime:eventFrequency
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype
    l: elementdefinition-defaulttype
  value: Canonical
    v: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
    l: SXCM-TS
path:
  v: SubstanceAdministration.effectiveTime
representation:
  v: typeAttr
slice name:
  v: eventFrequency
short:
  v: This effectiveTime represents an event-based medication frequency (e.g., administration at bedtime).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.effectiveTime
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS
    l: PIVL-TS

id:
  v: SubstanceAdministration.effectiveTime:eventFrequency.nullFlavor
path:
  v: SubstanceAdministration.effectiveTime.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.effectiveTime:eventFrequency.value
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format
    l: elementdefinition-date-format
  value: String
    v: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules
    l: elementdefinition-date-rules
  value: String
    v: year-valid
path:
  v: SubstanceAdministration.effectiveTime.value
representation:
  v: xmlAttr
definition:
  v: A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: TS.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ts-simple
    l: ts-simple

id:
  v: SubstanceAdministration.effectiveTime:eventFrequency.operator
path:
  v: SubstanceAdministration.effectiveTime.operator
representation:
  v: xmlAttr
definition:
  v: A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.
comment:
  v: SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SXCM_TS.operator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
default value: Code
  v: I
pattern: Code
  v: A
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
    l: CDASetOperator

id:
  v: SubstanceAdministration.effectiveTime:eventFrequency.phase
path:
  v: SubstanceAdministration.effectiveTime.phase
label:
  v: Phase
definition:
  v: A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PIVL_TS.phase
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
    l: IVL-TS

id:
  v: SubstanceAdministration.effectiveTime:eventFrequency.period
path:
  v: SubstanceAdministration.effectiveTime.period
label:
  v: Period
definition:
  v: A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PIVL_TS.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PQ
    l: PQ

id:
  v: SubstanceAdministration.effectiveTime:eventFrequency.alignment
path:
  v: SubstanceAdministration.effectiveTime.alignment
representation:
  v: xmlAttr
label:
  v: Alignment to the Calendar
definition:
  v: Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from "the 5th of every month".) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PIVL_TS.alignment
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: SubstanceAdministration.effectiveTime:eventFrequency.institutionSpecified
path:
  v: SubstanceAdministration.effectiveTime.institutionSpecified
representation:
  v: xmlAttr
label:
  v: Institution Specified Timing
definition:
  v: Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish "every 8 hours" from "3 times a day".)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PIVL_TS.institutionSpecified
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.priorityCode
path:
  v: SubstanceAdministration.priorityCode
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.priorityCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
binding:
  strength:
    v: example
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-ActPriority
    l: v3-ActPriority

id:
  v: SubstanceAdministration.repeatNumber
path:
  v: SubstanceAdministration.repeatNumber
short:
  v: In a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
comment:
  v: MAY contain zero or one [0..1] repeatNumber (CONF:1098-32066).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.repeatNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
    l: IVL-INT

id:
  v: SubstanceAdministration.routeCode
path:
  v: SubstanceAdministration.routeCode
comment:
  v: MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32067).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.routeCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
constraint:
  key:
    v: should-translation
  severity:
    v: warning
  human:
    v: SHOULD contain translation
  expression:
    v: translation.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
    l: PlannedMedicationActivity
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7

id:
  v: SubstanceAdministration.routeCode.nullFlavor
path:
  v: SubstanceAdministration.routeCode.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.routeCode.code
path:
  v: SubstanceAdministration.routeCode.code
representation:
  v: xmlAttr
label:
  v: Code
definition:
  v: The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: SubstanceAdministration.routeCode.codeSystem
path:
  v: SubstanceAdministration.routeCode.codeSystem
representation:
  v: xmlAttr
label:
  v: Code System
definition:
  v: Specifies the code system that defines the code.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystem
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid

id:
  v: SubstanceAdministration.routeCode.codeSystemName
path:
  v: SubstanceAdministration.routeCode.codeSystemName
representation:
  v: xmlAttr
label:
  v: Code System Name
definition:
  v: The common name of the coding system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystemName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.routeCode.codeSystemVersion
path:
  v: SubstanceAdministration.routeCode.codeSystemVersion
representation:
  v: xmlAttr
label:
  v: Code System Version
definition:
  v: If applicable, a version descriptor defined specifically for the given code system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystemVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.routeCode.displayName
path:
  v: SubstanceAdministration.routeCode.displayName
representation:
  v: xmlAttr
label:
  v: Display Name
definition:
  v: A name or title for the code, under which the sending system shows the code value to its users.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.displayName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.routeCode.sdtcValueSet
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSet
path:
  v: SubstanceAdministration.routeCode.sdtcValueSet
representation:
  v: xmlAttr
definition:
  v: The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.valueSet
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid

id:
  v: SubstanceAdministration.routeCode.sdtcValueSetVersion
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSetVersion
path:
  v: SubstanceAdministration.routeCode.sdtcValueSetVersion
representation:
  v: xmlAttr
definition:
  v: The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.sdtcValueSetVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.routeCode.originalText
path:
  v: SubstanceAdministration.routeCode.originalText
label:
  v: Original Text
definition:
  v: The text or phrase used as the basis for the coding.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.originalText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: SubstanceAdministration.routeCode.qualifier
path:
  v: SubstanceAdministration.routeCode.qualifier
label:
  v: Qualifier
definition:
  v: Specifies additional codes that increase the specificity of the the primary code.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CR
    l: CR

id:
  v: SubstanceAdministration.routeCode.translation
path:
  v: SubstanceAdministration.routeCode.translation
representation:
  v: typeAttr
label:
  v: Translation
definition:
  v: A set of other concept descriptors that translate this concept descriptor into other code systems.
comment:
  v: The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952).
min:
  v: 0
max:
  v: *
base:
  path:
    v: CD.translation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CD
    l: CD
binding:
  strength:
    v: preferred
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12

id:
  v: SubstanceAdministration.approachSiteCode
path:
  v: SubstanceAdministration.approachSiteCode
comment:
  v: MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32078).
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.approachSiteCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CD
    l: CD
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9

id:
  v: SubstanceAdministration.doseQuantity
path:
  v: SubstanceAdministration.doseQuantity
comment:
  v: MAY contain zero or one [0..1] doseQuantity (CONF:1098-32068).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.doseQuantity
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
    l: IVL-PQ
constraint:
  key:
    v: should-unit
  severity:
    v: warning
  human:
    v: SHOULD contain @unit
  expression:
    v: nullFlavor.exists() or unit.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
    l: PlannedMedicationActivity

id:
  v: SubstanceAdministration.doseQuantity.nullFlavor
path:
  v: SubstanceAdministration.doseQuantity.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.doseQuantity.unit
path:
  v: SubstanceAdministration.doseQuantity.unit
representation:
  v: xmlAttr
label:
  v: Unit of Measure
short:
  v: NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
definition:
  v: The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].
comment:
  v: The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32133).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PQ.unit
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
default value: Code
  v: 1
binding:
  strength:
    v: preferred
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive
    l: v3-UnitsOfMeasureCaseSensitive

id:
  v: SubstanceAdministration.doseQuantity.value
path:
  v: SubstanceAdministration.doseQuantity.value
representation:
  v: xmlAttr
label:
  v: Maginitude Value
definition:
  v: The magnitude of the quantity measured in terms of the unit.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PQ.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: decimal
    l: decimal
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/real-simple
    l: real-simple

id:
  v: SubstanceAdministration.doseQuantity.translation
path:
  v: SubstanceAdministration.doseQuantity.translation
label:
  v: Translation
definition:
  v: An alternative representation of the same physical quantity expressed in a different unit, of a different unit code system and possibly with a different value.
min:
  v: 0
max:
  v: *
base:
  path:
    v: PQ.translation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PQR
    l: PQR

id:
  v: SubstanceAdministration.doseQuantity.operator
path:
  v: SubstanceAdministration.doseQuantity.operator
representation:
  v: xmlAttr
definition:
  v: A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_PQ.operator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
default value: Code
  v: I
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
    l: CDASetOperator

id:
  v: SubstanceAdministration.doseQuantity.low
path:
  v: SubstanceAdministration.doseQuantity.low
label:
  v: Low Boundary
definition:
  v: This is the low limit of the interval.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_PQ.low
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
    l: IVXB-PQ

id:
  v: SubstanceAdministration.doseQuantity.center
path:
  v: SubstanceAdministration.doseQuantity.center
label:
  v: Central Value
definition:
  v: The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_PQ.center
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PQ
    l: PQ

id:
  v: SubstanceAdministration.doseQuantity.width
path:
  v: SubstanceAdministration.doseQuantity.width
label:
  v: Width
definition:
  v: The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_PQ.width
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PQ
    l: PQ

id:
  v: SubstanceAdministration.doseQuantity.high
path:
  v: SubstanceAdministration.doseQuantity.high
label:
  v: High Boundary
definition:
  v: This is the high limit of the interval.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_PQ.high
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
    l: IVXB-PQ

id:
  v: SubstanceAdministration.rateQuantity
path:
  v: SubstanceAdministration.rateQuantity
comment:
  v: MAY contain zero or one [0..1] rateQuantity (CONF:1098-32079).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.rateQuantity
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
    l: IVL-PQ
constraint:
  key:
    v: should-unit
  severity:
    v: warning
  human:
    v: SHOULD contain @unit
  expression:
    v: nullFlavor.exists() or unit.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
    l: PlannedMedicationActivity

id:
  v: SubstanceAdministration.rateQuantity.nullFlavor
path:
  v: SubstanceAdministration.rateQuantity.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.rateQuantity.unit
path:
  v: SubstanceAdministration.rateQuantity.unit
representation:
  v: xmlAttr
label:
  v: Unit of Measure
short:
  v: NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
definition:
  v: The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].
comment:
  v: The rateQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32134).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PQ.unit
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
default value: Code
  v: 1
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive
    l: v3-UnitsOfMeasureCaseSensitive

id:
  v: SubstanceAdministration.rateQuantity.value
path:
  v: SubstanceAdministration.rateQuantity.value
representation:
  v: xmlAttr
label:
  v: Maginitude Value
definition:
  v: The magnitude of the quantity measured in terms of the unit.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PQ.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: decimal
    l: decimal
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/real-simple
    l: real-simple

id:
  v: SubstanceAdministration.rateQuantity.translation
path:
  v: SubstanceAdministration.rateQuantity.translation
label:
  v: Translation
definition:
  v: An alternative representation of the same physical quantity expressed in a different unit, of a different unit code system and possibly with a different value.
min:
  v: 0
max:
  v: *
base:
  path:
    v: PQ.translation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PQR
    l: PQR

id:
  v: SubstanceAdministration.rateQuantity.operator
path:
  v: SubstanceAdministration.rateQuantity.operator
representation:
  v: xmlAttr
definition:
  v: A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_PQ.operator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
default value: Code
  v: I
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
    l: CDASetOperator

id:
  v: SubstanceAdministration.rateQuantity.low
path:
  v: SubstanceAdministration.rateQuantity.low
label:
  v: Low Boundary
definition:
  v: This is the low limit of the interval.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_PQ.low
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
    l: IVXB-PQ

id:
  v: SubstanceAdministration.rateQuantity.center
path:
  v: SubstanceAdministration.rateQuantity.center
label:
  v: Central Value
definition:
  v: The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_PQ.center
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PQ
    l: PQ

id:
  v: SubstanceAdministration.rateQuantity.width
path:
  v: SubstanceAdministration.rateQuantity.width
label:
  v: Width
definition:
  v: The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_PQ.width
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PQ
    l: PQ

id:
  v: SubstanceAdministration.rateQuantity.high
path:
  v: SubstanceAdministration.rateQuantity.high
label:
  v: High Boundary
definition:
  v: This is the high limit of the interval.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IVL_PQ.high
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
    l: IVXB-PQ

id:
  v: SubstanceAdministration.maxDoseQuantity
path:
  v: SubstanceAdministration.maxDoseQuantity
comment:
  v: MAY contain zero or one [0..1] maxDoseQuantity (CONF:1098-32080).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.maxDoseQuantity
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
    l: RTO-PQ-PQ

id:
  v: SubstanceAdministration.administrationUnitCode
path:
  v: SubstanceAdministration.administrationUnitCode
comment:
  v: MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1098-32081).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.administrationUnitCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30

id:
  v: SubstanceAdministration.consumable
path:
  v: SubstanceAdministration.consumable
definition:
  v: The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.
comment:
  v: SHALL contain exactly one [1..1] consumable (CONF:1098-32082).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.consumable
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: SubstanceAdministration.consumable.nullFlavor
path:
  v: SubstanceAdministration.consumable.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.consumable.realmCode
path:
  v: SubstanceAdministration.consumable.realmCode
definition:
  v: When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: SubstanceAdministration.consumable.typeId
path:
  v: SubstanceAdministration.consumable.typeId
definition:
  v: When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
    l: SubstanceAdministration

id:
  v: SubstanceAdministration.consumable.typeId.nullFlavor
path:
  v: SubstanceAdministration.consumable.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.consumable.typeId.assigningAuthorityName
path:
  v: SubstanceAdministration.consumable.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.consumable.typeId.displayable
path:
  v: SubstanceAdministration.consumable.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.consumable.typeId.root
path:
  v: SubstanceAdministration.consumable.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: SubstanceAdministration.consumable.typeId.extension
path:
  v: SubstanceAdministration.consumable.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.consumable.templateId
path:
  v: SubstanceAdministration.consumable.templateId
definition:
  v: When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: SubstanceAdministration.consumable.typeCode
path:
  v: SubstanceAdministration.consumable.typeCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.consumable.typeCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: CSM
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
    l: CDAParticipationType

id:
  v: SubstanceAdministration.consumable.manufacturedProduct
path:
  v: SubstanceAdministration.consumable.manufacturedProduct
comment:
  v: This consumable SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-32083).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.consumable.manufacturedProduct
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
    l: ManufacturedProduct
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationInformation
    l: MedicationInformation

id:
  v: SubstanceAdministration.subject
path:
  v: SubstanceAdministration.subject
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.subject
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Subject
    l: Subject

id:
  v: SubstanceAdministration.specimen
path:
  v: SubstanceAdministration.specimen
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.specimen
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Specimen
    l: Specimen

id:
  v: SubstanceAdministration.performer
path:
  v: SubstanceAdministration.performer
short:
  v: The clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer.
comment:
  v: MAY contain zero or more [0..*] performer (CONF:1098-30470).
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.performer
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Performer2
    l: Performer2

id:
  v: SubstanceAdministration.author
path:
  v: SubstanceAdministration.author
short:
  v: The author in a planned medication activity represents the clinician who is requesting or planning the medication activity.
comment:
  v: SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32046).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubstanceAdministration.author
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Author
    l: Author
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation
    l: AuthorParticipation

id:
  v: SubstanceAdministration.informant
path:
  v: SubstanceAdministration.informant
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.informant
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Informant
    l: Informant

id:
  v: SubstanceAdministration.participant
path:
  v: SubstanceAdministration.participant
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.participant
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Participant2
    l: Participant2

id:
  v: SubstanceAdministration.entryRelationship
path:
  v: SubstanceAdministration.entryRelationship
slicing:
  discriminator:
    type:
      v: profile
    path:
      v: observation
  rules:
    v: open
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.entryRelationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
    l: EntryRelationship

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference
path:
  v: SubstanceAdministration.entryRelationship
slice name:
  v: priorityPreference
short:
  v: The following entryRelationship represents the priority that a patient or a provider places on the planned medication activity.
comment:
  v: MAY contain zero or more [0..*] entryRelationship (CONF:1098-31104) such that it
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.entryRelationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
    l: EntryRelationship

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.nullFlavor
path:
  v: SubstanceAdministration.entryRelationship.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.realmCode
path:
  v: SubstanceAdministration.entryRelationship.realmCode
definition:
  v: When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.typeId
path:
  v: SubstanceAdministration.entryRelationship.typeId
definition:
  v: When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.typeId.nullFlavor
path:
  v: SubstanceAdministration.entryRelationship.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.typeId.assigningAuthorityName
path:
  v: SubstanceAdministration.entryRelationship.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.typeId.displayable
path:
  v: SubstanceAdministration.entryRelationship.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.typeId.root
path:
  v: SubstanceAdministration.entryRelationship.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.typeId.extension
path:
  v: SubstanceAdministration.entryRelationship.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.templateId
path:
  v: SubstanceAdministration.entryRelationship.templateId
definition:
  v: When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.typeCode
path:
  v: SubstanceAdministration.entryRelationship.typeCode
representation:
  v: xmlAttr
comment:
  v: SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31105).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EntryRelationship.typeCode
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: REFR
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    l: v3-xActRelationshipEntryRelationship

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.inversionInd
path:
  v: SubstanceAdministration.entryRelationship.inversionInd
representation:
  v: xmlAttr
definition:
  v: The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.inversionInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.contextConductionInd
path:
  v: SubstanceAdministration.entryRelationship.contextConductionInd
representation:
  v: xmlAttr
definition:
  v: The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.contextConductionInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple
default value: Boolean
  v: true

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.negationInd
path:
  v: SubstanceAdministration.entryRelationship.negationInd
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.negationInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.sequenceNumber
path:
  v: SubstanceAdministration.entryRelationship.sequenceNumber
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.sequenceNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/INT
    l: INT

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.seperatableInd
path:
  v: SubstanceAdministration.entryRelationship.seperatableInd
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.seperatableInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/BL
    l: BL

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.act
path:
  v: SubstanceAdministration.entryRelationship.act
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.act
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Act
    l: Act

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.encounter
path:
  v: SubstanceAdministration.entryRelationship.encounter
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.encounter
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Encounter
    l: Encounter

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.observation
path:
  v: SubstanceAdministration.entryRelationship.observation
comment:
  v: SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31106).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EntryRelationship.observation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Observation
    l: Observation
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PriorityPreference
    l: PriorityPreference

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.observationMedia
path:
  v: SubstanceAdministration.entryRelationship.observationMedia
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.observationMedia
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
    l: ObservationMedia

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.organizer
path:
  v: SubstanceAdministration.entryRelationship.organizer
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.organizer
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Organizer
    l: Organizer

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.procedure
path:
  v: SubstanceAdministration.entryRelationship.procedure
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.procedure
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Procedure
    l: Procedure

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.regionOfInterest
path:
  v: SubstanceAdministration.entryRelationship.regionOfInterest
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.regionOfInterest
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
    l: RegionOfInterest

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.substanceAdministration
path:
  v: SubstanceAdministration.entryRelationship.substanceAdministration
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.substanceAdministration
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
    l: SubstanceAdministration

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.supply
path:
  v: SubstanceAdministration.entryRelationship.supply
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.supply
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Supply
    l: Supply

id:
  v: SubstanceAdministration.entryRelationship:indication
path:
  v: SubstanceAdministration.entryRelationship
slice name:
  v: indication
short:
  v: The following entryRelationship represents the indication for the planned medication activity.
comment:
  v: MAY contain zero or more [0..*] entryRelationship (CONF:1098-32069) such that it
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.entryRelationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
    l: EntryRelationship

id:
  v: SubstanceAdministration.entryRelationship:indication.nullFlavor
path:
  v: SubstanceAdministration.entryRelationship.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.entryRelationship:indication.realmCode
path:
  v: SubstanceAdministration.entryRelationship.realmCode
definition:
  v: When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: SubstanceAdministration.entryRelationship:indication.typeId
path:
  v: SubstanceAdministration.entryRelationship.typeId
definition:
  v: When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: SubstanceAdministration.entryRelationship:indication.typeId.nullFlavor
path:
  v: SubstanceAdministration.entryRelationship.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.entryRelationship:indication.typeId.assigningAuthorityName
path:
  v: SubstanceAdministration.entryRelationship.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.entryRelationship:indication.typeId.displayable
path:
  v: SubstanceAdministration.entryRelationship.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.entryRelationship:indication.typeId.root
path:
  v: SubstanceAdministration.entryRelationship.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: SubstanceAdministration.entryRelationship:indication.typeId.extension
path:
  v: SubstanceAdministration.entryRelationship.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.entryRelationship:indication.templateId
path:
  v: SubstanceAdministration.entryRelationship.templateId
definition:
  v: When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: SubstanceAdministration.entryRelationship:indication.typeCode
path:
  v: SubstanceAdministration.entryRelationship.typeCode
representation:
  v: xmlAttr
comment:
  v: SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32070).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EntryRelationship.typeCode
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: RSON
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    l: v3-xActRelationshipEntryRelationship

id:
  v: SubstanceAdministration.entryRelationship:indication.inversionInd
path:
  v: SubstanceAdministration.entryRelationship.inversionInd
representation:
  v: xmlAttr
definition:
  v: The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.inversionInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.entryRelationship:indication.contextConductionInd
path:
  v: SubstanceAdministration.entryRelationship.contextConductionInd
representation:
  v: xmlAttr
definition:
  v: The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.contextConductionInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple
default value: Boolean
  v: true

id:
  v: SubstanceAdministration.entryRelationship:indication.negationInd
path:
  v: SubstanceAdministration.entryRelationship.negationInd
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.negationInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.entryRelationship:indication.sequenceNumber
path:
  v: SubstanceAdministration.entryRelationship.sequenceNumber
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.sequenceNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/INT
    l: INT

id:
  v: SubstanceAdministration.entryRelationship:indication.seperatableInd
path:
  v: SubstanceAdministration.entryRelationship.seperatableInd
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.seperatableInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/BL
    l: BL

id:
  v: SubstanceAdministration.entryRelationship:indication.act
path:
  v: SubstanceAdministration.entryRelationship.act
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.act
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Act
    l: Act

id:
  v: SubstanceAdministration.entryRelationship:indication.encounter
path:
  v: SubstanceAdministration.entryRelationship.encounter
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.encounter
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Encounter
    l: Encounter

id:
  v: SubstanceAdministration.entryRelationship:indication.observation
path:
  v: SubstanceAdministration.entryRelationship.observation
comment:
  v: SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32071).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EntryRelationship.observation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Observation
    l: Observation
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/Indication
    l: Indication

id:
  v: SubstanceAdministration.entryRelationship:indication.observationMedia
path:
  v: SubstanceAdministration.entryRelationship.observationMedia
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.observationMedia
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
    l: ObservationMedia

id:
  v: SubstanceAdministration.entryRelationship:indication.organizer
path:
  v: SubstanceAdministration.entryRelationship.organizer
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.organizer
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Organizer
    l: Organizer

id:
  v: SubstanceAdministration.entryRelationship:indication.procedure
path:
  v: SubstanceAdministration.entryRelationship.procedure
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.procedure
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Procedure
    l: Procedure

id:
  v: SubstanceAdministration.entryRelationship:indication.regionOfInterest
path:
  v: SubstanceAdministration.entryRelationship.regionOfInterest
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.regionOfInterest
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
    l: RegionOfInterest

id:
  v: SubstanceAdministration.entryRelationship:indication.substanceAdministration
path:
  v: SubstanceAdministration.entryRelationship.substanceAdministration
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.substanceAdministration
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
    l: SubstanceAdministration

id:
  v: SubstanceAdministration.entryRelationship:indication.supply
path:
  v: SubstanceAdministration.entryRelationship.supply
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.supply
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Supply
    l: Supply

id:
  v: SubstanceAdministration.entryRelationship:instruction
path:
  v: SubstanceAdministration.entryRelationship
slice name:
  v: instruction
short:
  v: The following entryRelationship captures any instructions associated with the planned medication activity.
comment:
  v: MAY contain zero or more [0..*] entryRelationship (CONF:1098-32072) such that it
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.entryRelationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
    l: EntryRelationship

id:
  v: SubstanceAdministration.entryRelationship:instruction.nullFlavor
path:
  v: SubstanceAdministration.entryRelationship.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.entryRelationship:instruction.realmCode
path:
  v: SubstanceAdministration.entryRelationship.realmCode
definition:
  v: When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: SubstanceAdministration.entryRelationship:instruction.typeId
path:
  v: SubstanceAdministration.entryRelationship.typeId
definition:
  v: When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: SubstanceAdministration.entryRelationship:instruction.typeId.nullFlavor
path:
  v: SubstanceAdministration.entryRelationship.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.entryRelationship:instruction.typeId.assigningAuthorityName
path:
  v: SubstanceAdministration.entryRelationship.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.entryRelationship:instruction.typeId.displayable
path:
  v: SubstanceAdministration.entryRelationship.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.entryRelationship:instruction.typeId.root
path:
  v: SubstanceAdministration.entryRelationship.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: SubstanceAdministration.entryRelationship:instruction.typeId.extension
path:
  v: SubstanceAdministration.entryRelationship.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.entryRelationship:instruction.templateId
path:
  v: SubstanceAdministration.entryRelationship.templateId
definition:
  v: When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: SubstanceAdministration.entryRelationship:instruction.typeCode
path:
  v: SubstanceAdministration.entryRelationship.typeCode
representation:
  v: xmlAttr
comment:
  v: SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32073).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EntryRelationship.typeCode
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: SUBJ
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    l: v3-xActRelationshipEntryRelationship

id:
  v: SubstanceAdministration.entryRelationship:instruction.inversionInd
path:
  v: SubstanceAdministration.entryRelationship.inversionInd
representation:
  v: xmlAttr
definition:
  v: The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.inversionInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.entryRelationship:instruction.contextConductionInd
path:
  v: SubstanceAdministration.entryRelationship.contextConductionInd
representation:
  v: xmlAttr
definition:
  v: The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.contextConductionInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple
default value: Boolean
  v: true

id:
  v: SubstanceAdministration.entryRelationship:instruction.negationInd
path:
  v: SubstanceAdministration.entryRelationship.negationInd
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.negationInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.entryRelationship:instruction.sequenceNumber
path:
  v: SubstanceAdministration.entryRelationship.sequenceNumber
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.sequenceNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/INT
    l: INT

id:
  v: SubstanceAdministration.entryRelationship:instruction.seperatableInd
path:
  v: SubstanceAdministration.entryRelationship.seperatableInd
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.seperatableInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/BL
    l: BL

id:
  v: SubstanceAdministration.entryRelationship:instruction.act
path:
  v: SubstanceAdministration.entryRelationship.act
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.act
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Act
    l: Act

id:
  v: SubstanceAdministration.entryRelationship:instruction.encounter
path:
  v: SubstanceAdministration.entryRelationship.encounter
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.encounter
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Encounter
    l: Encounter

id:
  v: SubstanceAdministration.entryRelationship:instruction.observation
path:
  v: SubstanceAdministration.entryRelationship.observation
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EntryRelationship.observation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Observation
    l: Observation
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/InstructionObservation
    l: InstructionObservation

id:
  v: SubstanceAdministration.entryRelationship:instruction.observationMedia
path:
  v: SubstanceAdministration.entryRelationship.observationMedia
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.observationMedia
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
    l: ObservationMedia

id:
  v: SubstanceAdministration.entryRelationship:instruction.organizer
path:
  v: SubstanceAdministration.entryRelationship.organizer
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.organizer
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Organizer
    l: Organizer

id:
  v: SubstanceAdministration.entryRelationship:instruction.procedure
path:
  v: SubstanceAdministration.entryRelationship.procedure
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.procedure
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Procedure
    l: Procedure

id:
  v: SubstanceAdministration.entryRelationship:instruction.regionOfInterest
path:
  v: SubstanceAdministration.entryRelationship.regionOfInterest
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.regionOfInterest
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
    l: RegionOfInterest

id:
  v: SubstanceAdministration.entryRelationship:instruction.substanceAdministration
path:
  v: SubstanceAdministration.entryRelationship.substanceAdministration
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.substanceAdministration
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
    l: SubstanceAdministration

id:
  v: SubstanceAdministration.entryRelationship:instruction.supply
path:
  v: SubstanceAdministration.entryRelationship.supply
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EntryRelationship.supply
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Supply
    l: Supply

id:
  v: SubstanceAdministration.reference
path:
  v: SubstanceAdministration.reference
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.reference
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Reference
    l: Reference

id:
  v: SubstanceAdministration.precondition
path:
  v: SubstanceAdministration.precondition
comment:
  v: MAY contain zero or more [0..*] precondition (CONF:1098-32084).
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.precondition
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Precondition
    l: Precondition

id:
  v: SubstanceAdministration.precondition.nullFlavor
path:
  v: SubstanceAdministration.precondition.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.precondition.realmCode
path:
  v: SubstanceAdministration.precondition.realmCode
definition:
  v: When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: SubstanceAdministration.precondition.typeId
path:
  v: SubstanceAdministration.precondition.typeId
definition:
  v: When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: SubstanceAdministration.precondition.typeId.nullFlavor
path:
  v: SubstanceAdministration.precondition.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: SubstanceAdministration.precondition.typeId.assigningAuthorityName
path:
  v: SubstanceAdministration.precondition.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.precondition.typeId.displayable
path:
  v: SubstanceAdministration.precondition.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: SubstanceAdministration.precondition.typeId.root
path:
  v: SubstanceAdministration.precondition.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: SubstanceAdministration.precondition.typeId.extension
path:
  v: SubstanceAdministration.precondition.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: SubstanceAdministration.precondition.templateId
path:
  v: SubstanceAdministration.precondition.templateId
definition:
  v: When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: SubstanceAdministration.precondition.typeCode
path:
  v: SubstanceAdministration.precondition.typeCode
representation:
  v: xmlAttr
comment:
  v: The precondition, if present, SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32085).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Precondition.typeCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: PRCN
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
    l: CDAActRelationshipType

id:
  v: SubstanceAdministration.precondition.criterion
path:
  v: SubstanceAdministration.precondition.criterion
comment:
  v: The precondition, if present, SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32086).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Precondition.criterion
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Criterion
    l: Criterion
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PreconditionforSubstanceAdministration
    l: PreconditionforSubstanceAdministration

id:
  v: SubstanceAdministration.sdtcInFulfillmentOf1
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: inFulfillmentOf1
path:
  v: SubstanceAdministration.sdtcInFulfillmentOf1
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubstanceAdministration.sdtcInFulfillmentOf1
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
    l: InFulfillmentOf1

element:
  id:
    v: SubstanceAdministration
  path:
    v: SubstanceAdministration
  constraint:
    key:
      v: should-text-ref-value
    severity:
      v: warning
    human:
      v: SHOULD contain text/reference/@value
    expression:
      v: text.reference.value.exists()
    source:
      v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
      l: PlannedMedicationActivity
  constraint:
    key:
      v: dose-unit-or-admin-unit
    severity:
      v: error
    human:
      v: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
    expression:
      v: doseQuantity.unit.exists() implies administrationUnitCode.empty()
    source:
      v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
      l: PlannedMedicationActivity
  constraint:
    key:
      v: should-author
    severity:
      v: warning
    human:
      v: SHOULD contain author
    expression:
      v: author.exists()
    source:
      v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
      l: PlannedMedicationActivity
element:
  id:
    v: SubstanceAdministration.templateId
  path:
    v: SubstanceAdministration.templateId
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: root
    discriminator:
      type:
        v: value
      path:
        v: extension
    rules:
      v: open
  min:
    v: 1
element:
  id:
    v: SubstanceAdministration.templateId:planned-med-activity
  path:
    v: SubstanceAdministration.templateId
  slice name:
    v: planned-med-activity
  min:
    v: 1
  max:
    v: 1
element:
  id:
    v: SubstanceAdministration.templateId:planned-med-activity.root
  path:
    v: SubstanceAdministration.templateId.root
  min:
    v: 1
  pattern: String
    v: 2.16.840.1.113883.10.20.22.4.42
element:
  id:
    v: SubstanceAdministration.templateId:planned-med-activity.extension
  path:
    v: SubstanceAdministration.templateId.extension
  min:
    v: 1
  pattern: String
    v: 2014-06-09
element:
  id:
    v: SubstanceAdministration.classCode
  path:
    v: SubstanceAdministration.classCode
  comment:
    v: SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8572).
element:
  id:
    v: SubstanceAdministration.moodCode
  path:
    v: SubstanceAdministration.moodCode
  comment:
    v: SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8573).
  binding:
    strength:
      v: required
    value set:
      v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24
      l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24
element:
  id:
    v: SubstanceAdministration.id
  path:
    v: SubstanceAdministration.id
  comment:
    v: SHALL contain at least one [1..*] id (CONF:1098-8575).
  min:
    v: 1
element:
  id:
    v: SubstanceAdministration.text
  path:
    v: SubstanceAdministration.text
  short:
    v: SHOULD reference the portion of section narrative text corresponding to this entry
element:
  id:
    v: SubstanceAdministration.text.reference
  path:
    v: SubstanceAdministration.text.reference
  constraint:
    key:
      v: value-starts-octothorpe
    severity:
      v: error
    human:
      v: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
    expression:
      v: value.exists() implies value.startsWith('#')
    source:
      v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
      l: PlannedMedicationActivity
element:
  id:
    v: SubstanceAdministration.statusCode
  path:
    v: SubstanceAdministration.statusCode
  comment:
    v: SHALL contain exactly one [1..1] statusCode (CONF:1098-32087).
  min:
    v: 1
element:
  id:
    v: SubstanceAdministration.statusCode.code
  path:
    v: SubstanceAdministration.statusCode.code
  comment:
    v: This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32088).
  min:
    v: 1
  fixed: Code
    v: active
element:
  id:
    v: SubstanceAdministration.effectiveTime
  path:
    v: SubstanceAdministration.effectiveTime
  slicing:
    discriminator:
      type:
        v: type
      path:
        v: $this
    rules:
      v: open
  min:
    v: 1
element:
  id:
    v: SubstanceAdministration.effectiveTime:duration
  path:
    v: SubstanceAdministration.effectiveTime
  slice name:
    v: duration
  short:
    v: The effectiveTime in a planned medication activity represents the time that the medication activity should occur.
  comment:
    v: SHALL contain exactly one [1..1] effectiveTime (CONF:1098-30468) such that it
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
      l: IVL-TS
  constraint:
    key:
      v: 1098-32890
    severity:
      v: error

v: This effectiveTime **SHALL** contain either a low or a @value but not both (CONF:1098-32890).

v: (value.exists() or low.exists()) and ((value.exists() and low.exists()).not())

key:
  v: should-value-att
severity:
  v: warning
human:
  v: SHOULD contain @value
expression:
  v: value.exists()
source:
  v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
  l: PlannedMedicationActivity

key:
  v: should-low
severity:
  v: warning
human:
  v: SHOULD contain low
expression:
  v: low.exists()
source:
  v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
  l: PlannedMedicationActivity

id:
  v: SubstanceAdministration.effectiveTime:duration.value
path:
  v: SubstanceAdministration.effectiveTime.value
short:
  v: indicates a single-administration timestamp
comment:
  v: SHOULD contain zero or one [0..1] @value (CONF:1098-32775).

id:
  v: SubstanceAdministration.effectiveTime:duration.low
path:
  v: SubstanceAdministration.effectiveTime.low
short:
  v: indicates when medication started
comment:
  v: SHOULD contain zero or one [0..1] low (CONF:1098-32776).

id:
  v: SubstanceAdministration.effectiveTime:duration.high
path:
  v: SubstanceAdministration.effectiveTime.high
short:
  v: indicates when medication stopped
comment:
  v: MAY contain zero or one [0..1] high (CONF:1098-32777).

id:
  v: SubstanceAdministration.effectiveTime:periodicFrequency
path:
  v: SubstanceAdministration.effectiveTime
slice name:
  v: periodicFrequency
short:
  v: This effectiveTime represents a periodic medication frequency (e.g., administration times per day).
min:
  v: 0
max:
  v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS
    l: EIVL-TS

id:
  v: SubstanceAdministration.effectiveTime:periodicFrequency.operator
path:
  v: SubstanceAdministration.effectiveTime.operator
comment:
  v: SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106).
min:
  v: 1
pattern: Code
  v: A

id:
  v: SubstanceAdministration.effectiveTime:eventFrequency
path:
  v: SubstanceAdministration.effectiveTime
slice name:
  v: eventFrequency
short:
  v: This effectiveTime represents an event-based medication frequency (e.g., administration at bedtime).
min:
  v: 0
max:
  v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS
    l: PIVL-TS

id:
  v: SubstanceAdministration.effectiveTime:eventFrequency.operator
path:
  v: SubstanceAdministration.effectiveTime.operator
comment:
  v: SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106).
min:
  v: 1
pattern: Code
  v: A

id:
  v: SubstanceAdministration.repeatNumber
path:
  v: SubstanceAdministration.repeatNumber
short:
  v: In a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
comment:
  v: MAY contain zero or one [0..1] repeatNumber (CONF:1098-32066).

id:
  v: SubstanceAdministration.routeCode
path:
  v: SubstanceAdministration.routeCode
comment:
  v: MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32067).
constraint:
  key:
    v: should-translation
  severity:
    v: warning
  human:
    v: SHOULD contain translation
  expression:
    v: translation.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
    l: PlannedMedicationActivity
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7

id:
  v: SubstanceAdministration.routeCode.translation
path:
  v: SubstanceAdministration.routeCode.translation
comment:
  v: The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952).
binding:
  strength:
    v: preferred
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12

id:
  v: SubstanceAdministration.approachSiteCode
path:
  v: SubstanceAdministration.approachSiteCode
comment:
  v: MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32078).
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9

id:
  v: SubstanceAdministration.doseQuantity
path:
  v: SubstanceAdministration.doseQuantity
comment:
  v: MAY contain zero or one [0..1] doseQuantity (CONF:1098-32068).
constraint:
  key:
    v: should-unit
  severity:
    v: warning
  human:
    v: SHOULD contain @unit
  expression:
    v: nullFlavor.exists() or unit.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
    l: PlannedMedicationActivity

id:
  v: SubstanceAdministration.doseQuantity.unit
path:
  v: SubstanceAdministration.doseQuantity.unit
short:
  v: NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
comment:
  v: The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32133).
binding:
  strength:
    v: preferred
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive
    l: v3-UnitsOfMeasureCaseSensitive

id:
  v: SubstanceAdministration.rateQuantity
path:
  v: SubstanceAdministration.rateQuantity
comment:
  v: MAY contain zero or one [0..1] rateQuantity (CONF:1098-32079).
constraint:
  key:
    v: should-unit
  severity:
    v: warning
  human:
    v: SHOULD contain @unit
  expression:
    v: nullFlavor.exists() or unit.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedMedicationActivity
    l: PlannedMedicationActivity

id:
  v: SubstanceAdministration.rateQuantity.unit
path:
  v: SubstanceAdministration.rateQuantity.unit
short:
  v: NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
comment:
  v: The rateQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32134).
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive
    l: v3-UnitsOfMeasureCaseSensitive

id:
  v: SubstanceAdministration.maxDoseQuantity
path:
  v: SubstanceAdministration.maxDoseQuantity
comment:
  v: MAY contain zero or one [0..1] maxDoseQuantity (CONF:1098-32080).

id:
  v: SubstanceAdministration.administrationUnitCode
path:
  v: SubstanceAdministration.administrationUnitCode
comment:
  v: MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1098-32081).
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30

id:
  v: SubstanceAdministration.consumable
path:
  v: SubstanceAdministration.consumable
comment:
  v: SHALL contain exactly one [1..1] consumable (CONF:1098-32082).

id:
  v: SubstanceAdministration.consumable.manufacturedProduct
path:
  v: SubstanceAdministration.consumable.manufacturedProduct
comment:
  v: This consumable SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-32083).
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
    l: ManufacturedProduct
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationInformation
    l: MedicationInformation

id:
  v: SubstanceAdministration.performer
path:
  v: SubstanceAdministration.performer
short:
  v: The clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer.
comment:
  v: MAY contain zero or more [0..*] performer (CONF:1098-30470).

id:
  v: SubstanceAdministration.author
path:
  v: SubstanceAdministration.author
short:
  v: The author in a planned medication activity represents the clinician who is requesting or planning the medication activity.
comment:
  v: SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32046).
max:
  v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Author
    l: Author
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation
    l: AuthorParticipation

id:
  v: SubstanceAdministration.entryRelationship
path:
  v: SubstanceAdministration.entryRelationship
slicing:
  discriminator:
    type:
      v: profile
    path:
      v: observation
  rules:
    v: open

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference
path:
  v: SubstanceAdministration.entryRelationship
slice name:
  v: priorityPreference
short:
  v: The following entryRelationship represents the priority that a patient or a provider places on the planned medication activity.
comment:
  v: MAY contain zero or more [0..*] entryRelationship (CONF:1098-31104) such that it
min:
  v: 0
max:
  v: *

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.typeCode
path:
  v: SubstanceAdministration.entryRelationship.typeCode
comment:
  v: SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31105).
fixed: Code
  v: REFR

id:
  v: SubstanceAdministration.entryRelationship:priorityPreference.observation
path:
  v: SubstanceAdministration.entryRelationship.observation
comment:
  v: SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31106).
min:
  v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Observation
    l: Observation
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PriorityPreference
    l: PriorityPreference

id:
  v: SubstanceAdministration.entryRelationship:indication
path:
  v: SubstanceAdministration.entryRelationship
slice name:
  v: indication
short:
  v: The following entryRelationship represents the indication for the planned medication activity.
comment:
  v: MAY contain zero or more [0..*] entryRelationship (CONF:1098-32069) such that it
min:
  v: 0
max:
  v: *

id:
  v: SubstanceAdministration.entryRelationship:indication.typeCode
path:
  v: SubstanceAdministration.entryRelationship.typeCode
comment:
  v: SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32070).
fixed: Code
  v: RSON

id:
  v: SubstanceAdministration.entryRelationship:indication.observation
path:
  v: SubstanceAdministration.entryRelationship.observation
comment:
  v: SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32071).
min:
  v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Observation
    l: Observation
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/Indication
    l: Indication

id:
  v: SubstanceAdministration.entryRelationship:instruction
path:
  v: SubstanceAdministration.entryRelationship
slice name:
  v: instruction
short:
  v: The following entryRelationship captures any instructions associated with the planned medication activity.
comment:
  v: MAY contain zero or more [0..*] entryRelationship (CONF:1098-32072) such that it
min:
  v: 0
max:
  v: *

id:
  v: SubstanceAdministration.entryRelationship:instruction.typeCode
path:
  v: SubstanceAdministration.entryRelationship.typeCode
comment:
  v: SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32073).
fixed: Code
  v: SUBJ

id:
  v: SubstanceAdministration.entryRelationship:instruction.observation
path:
  v: SubstanceAdministration.entryRelationship.observation
min:
  v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Observation
    l: Observation
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/InstructionObservation
    l: InstructionObservation

id:
  v: SubstanceAdministration.precondition
path:
  v: SubstanceAdministration.precondition
comment:
  v: MAY contain zero or more [0..*] precondition (CONF:1098-32084).

id:
  v: SubstanceAdministration.precondition.typeCode
path:
  v: SubstanceAdministration.precondition.typeCode
comment:
  v: The precondition, if present, SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32085).
min:
  v: 1

id:
  v: SubstanceAdministration.precondition.criterion
path:
  v: SubstanceAdministration.precondition.criterion
comment:
  v: The precondition, if present, SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32086).
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Criterion
    l: Criterion
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/PreconditionforSubstanceAdministration
    l: PreconditionforSubstanceAdministration