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

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

Resource Profile: NonMedicinalSupplyActivity - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.4.50 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Supply
2. Supply.classCode
Requirements

SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8745).

Pattern ValueSPLY
3. Supply.moodCode
BindingThe codes SHALL be taken from MoodCodeEvnIntFor codes, see (unbound)
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:1098-8746).

4. Supply.templateId
SlicingThis element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. Supply.templateId:primary
SliceNameprimary
Control1..1
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-8747) such that it

6. Supply.templateId:primary.root
Control1..1
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.50" (CONF:1098-10509).

Pattern Value2.16.840.1.113883.10.20.22.4.50
7. Supply.templateId:primary.extension
Control1..1
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32514).

Pattern Value2014-06-09
8. Supply.id
Control10..*
Requirements

SHALL contain at least one [1..*] id (CONF:1098-8748).

9. Supply.statusCode
Control10..1
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-8749).

10. Supply.statusCode.code
Control1..1
BindingThe codes SHALL be taken from ActStatus
Requirements

This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1098-32363).

11. Supply.effectiveTime
Control0..1*
TypeChoice of: , http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15498).

InvariantsDefined on this element
1098-16867: The effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867). (: null)
12. Supply.quantity
Requirements

SHOULD contain zero or one [0..1] quantity (CONF:1098-8751).

13. Supply.participant
SlicingThis element introduces a set of slices on Supply.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
  • value @ typeCode,
14. Supply.participant:participant1
SliceNameparticipant1
Control0..1
Requirements

MAY contain zero or one [0..1] participant (CONF:1098-8752) such that it

15. Supply.participant:participant1.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="PRD" Product (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-8754).

Pattern ValuePRD
16. Supply.participant:participant1.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(ProductInstance)
Requirements

SHALL contain exactly one [1..1] Product Instance (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.37) (CONF:1098-15900).

17. Supply.entryRelationship
SlicingThis element introduces a set of slices on Supply.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ act
18. Supply.entryRelationship:instruction
SliceNameinstruction
Control0..1
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-30277) such that it

19. Supply.entryRelationship:instruction.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" (CONF:1098-30278).

Pattern ValueSUBJ
20. Supply.entryRelationship:instruction.inversionInd
Control1..1
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1098-30279).

Pattern Valuetrue
21. Supply.entryRelationship:instruction.act
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(Instruction)
Requirements

SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-31393).

Guidance on how to interpret the contents of this table can be found here.

1. Supply
Definition

Base definition for all types defined in FHIR type system.

Control10..1*
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Supply.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassSupply
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8745).

Default ValueSPLY
Fixed ValueSPLY
Pattern ValueSPLY
3. Supply.moodCode
Control1..1
BindingThe codes SHALL be taken from MoodCodeEvnInt
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:1098-8746).

4. Supply.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. Supply.templateId:primary
SliceNameprimary
Definition

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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-8747) such that it

6. Supply.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.50" (CONF:1098-10509).

Pattern Value2.16.840.1.113883.10.20.22.4.50
7. Supply.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32514).

Pattern Value2014-06-09
8. Supply.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1098-8748).

9. Supply.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-8749).

10. Supply.statusCode.code
Definition

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.

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1098-32363).

11. Supply.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
12. Supply.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. Supply.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
14. Supply.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
15. Supply.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
16. Supply.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
17. Supply.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
18. Supply.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EIVL-TS
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXCM-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15498).

InvariantsDefined on this element
1098-16867: The effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867). (: null)
19. Supply.quantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
Requirements

SHOULD contain zero or one [0..1] quantity (CONF:1098-8751).

20. Supply.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Supply.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
  • value @ typeCode,
21. Supply.participant:participant1
SliceNameparticipant1
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

MAY contain zero or one [0..1] participant (CONF:1098-8752) such that it

22. Supply.participant:participant1.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="PRD" Product (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-8754).

Pattern ValuePRD
23. Supply.participant:participant1.participantRole
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(ProductInstance)
Requirements

SHALL contain exactly one [1..1] Product Instance (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.37) (CONF:1098-15900).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Supply.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
sup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Supply.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ act
25. Supply.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
26. Supply.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
27. Supply.entryRelationship:instruction
SliceNameinstruction
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-30277) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
sup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
28. Supply.entryRelationship:instruction.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" (CONF:1098-30278).

Pattern ValueSUBJ
29. Supply.entryRelationship:instruction.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1098-30279).

Pattern Valuetrue
30. Supply.entryRelationship:instruction.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
31. Supply.entryRelationship:instruction.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
32. Supply.entryRelationship:instruction.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
33. Supply.entryRelationship:instruction.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
34. Supply.entryRelationship:instruction.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
35. Supply.entryRelationship:instruction.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
36. Supply.entryRelationship:instruction.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
37. Supply.entryRelationship:instruction.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
38. Supply.entryRelationship:instruction.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
39. Supply.entryRelationship:instruction.act
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(Instruction)
Requirements

SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-31393).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. Supply
Definition

Base definition for all types defined in FHIR type system.

Control1..1
2. Supply.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassSupply
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8745).

Default ValueSPLY
Fixed ValueSPLY
Pattern ValueSPLY
3. Supply.moodCode
Control1..1
BindingThe codes SHALL be taken from MoodCodeEvnInt
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:1098-8746).

4. Supply.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. Supply.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Supply.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
7. Supply.templateId:primary
SliceNameprimary
Definition

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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-8747) such that it

8. Supply.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
9. Supply.templateId:primary.assigningAuthorityName
Definition

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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
10. Supply.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
11. Supply.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.50" (CONF:1098-10509).

Pattern Value2.16.840.1.113883.10.20.22.4.50
12. Supply.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32514).

Pattern Value2014-06-09
13. Supply.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1098-8748).

14. Supply.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
15. Supply.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
16. Supply.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-8749).

17. Supply.statusCode.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
18. Supply.statusCode.code
Definition

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.

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1098-32363).

19. Supply.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
20. Supply.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
21. Supply.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
22. Supply.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
23. Supply.statusCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
24. Supply.statusCode.sdtcValueSetVersion
Definition

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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
25. Supply.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
26. Supply.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
27. Supply.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
28. Supply.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EIVL-TS
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXCM-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15498).

InvariantsDefined on this element
1098-16867: The effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867). (: )
29. Supply.priorityCode
Control0..*
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
30. Supply.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
31. Supply.independentInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
32. Supply.quantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
Requirements

SHOULD contain zero or one [0..1] quantity (CONF:1098-8751).

33. Supply.expectedUseTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
34. Supply.product
Control0..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Supply.product.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
36. Supply.product.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Supply.product.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
37. Supply.product.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetDirect
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePRD
Fixed ValuePRD
38. Supply.product.manufacturedProduct
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct
39. Supply.subject
Control0..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Supply.subject.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
41. Supply.subject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Supply.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
42. Supply.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBJ
Fixed ValueSBJ
43. Supply.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
44. Supply.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
45. Supply.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
46. Supply.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
47. Supply.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
48. Supply.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
49. Supply.informant
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. Supply.informant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
51. Supply.informant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Supply.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
52. Supply.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINF
Fixed ValueINF
53. Supply.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
54. Supply.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
55. Supply.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
56. Supply.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Supply.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
  • value @ typeCode,
57. Supply.participant:participant1
SliceNameparticipant1
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

MAY contain zero or one [0..1] participant (CONF:1098-8752) such that it

58. Supply.participant:participant1.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
59. Supply.participant:participant1.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="PRD" Product (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-8754).

Pattern ValuePRD
60. Supply.participant:participant1.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
61. Supply.participant:participant1.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
62. Supply.participant:participant1.typeId
Definition

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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
63. Supply.participant:participant1.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
64. Supply.participant:participant1.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name functionCode.
65. Supply.participant:participant1.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
66. Supply.participant:participant1.awarenessCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
67. Supply.participant:participant1.participantRole
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(ProductInstance)
Requirements

SHALL contain exactly one [1..1] Product Instance (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.37) (CONF:1098-15900).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. Supply.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
sup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Supply.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ act
69. Supply.entryRelationship.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
70. Supply.entryRelationship.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Supply.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
71. Supply.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
72. Supply.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
73. Supply.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
74. Supply.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
75. Supply.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
76. Supply.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
77. Supply.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
78. Supply.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
79. Supply.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
80. Supply.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
81. Supply.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
82. Supply.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
83. Supply.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
84. Supply.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
85. Supply.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
86. Supply.entryRelationship:instruction
SliceNameinstruction
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-30277) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
sup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
87. Supply.entryRelationship:instruction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
88. Supply.entryRelationship:instruction.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Supply.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
89. Supply.entryRelationship:instruction.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" (CONF:1098-30278).

Pattern ValueSUBJ
90. Supply.entryRelationship:instruction.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1098-30279).

Pattern Valuetrue
91. Supply.entryRelationship:instruction.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
92. Supply.entryRelationship:instruction.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
93. Supply.entryRelationship:instruction.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
94. Supply.entryRelationship:instruction.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
95. Supply.entryRelationship:instruction.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
96. Supply.entryRelationship:instruction.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
97. Supply.entryRelationship:instruction.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
98. Supply.entryRelationship:instruction.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
99. Supply.entryRelationship:instruction.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
100. Supply.entryRelationship:instruction.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
101. Supply.entryRelationship:instruction.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
102. Supply.entryRelationship:instruction.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
103. Supply.entryRelationship:instruction.act
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(Instruction)
Requirements

SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-31393).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
104. Supply.reference
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
105. Supply.reference.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
106. Supply.reference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Supply.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
107. Supply.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
108. Supply.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
109. Supply.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
110. Supply.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
111. Supply.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
112. Supply.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
113. Supply.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition