International Patient Summary 1.0.0 Release
1.0 - CI Build

International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions

Resource Profile: IPSMedicalDevice - Detailed Descriptions

Draft as of 2017-04-11

Definitions for the 2.16.840.1.113883.10.22.4.26--20170411000000 resource profile.

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

1. Supply
Definition

The element shall be present. The moodCode attribute shall be EVN to reflect that a medical device has been provided.

Base definition for all types defined in FHIR type system.

Control1..*1
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Supply.classCode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. Supply.moodCode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
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
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
6. Supply.templateId:primary.root
Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.10.22.4.26
7. Supply.id
Definition

This optional element identifies the provision of the device (e.g. implant procedure.html)

Must Supporttrue
8. Supply.text
Must Supporttrue
9. Supply.text.reference
Control1..1
Must Supporttrue
10. Supply.text.reference.value
Definition

Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
11. Supply.effectiveTime
Definition

This element provides the interval of time corresponding to the device usage by/presence in the patient.

Control10..1*
Must Supporttrue
XML RepresentationThe type of this property is determined using the xsi:type attribute.
12. Supply.effectiveTime.type
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueIVL_TS
13. Supply.effectiveTime.low
Definition

The lower bound of the interval represents the start date/time.

Control1..1
Must Supporttrue
14. Supply.effectiveTime.high
Definition

The upper bound represents the end date/time. If it is not present, the device is still used by or present in the patient.

Control0..1
15. Supply.participant
Definition

The device is represented as a participant in the supply structure. The following descriptions apply to the device structure.

Control10..*
Must Supporttrue
16. Supply.participant.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDEV
17. Supply.participant.participantRole
Control1..1
Must Supporttrue
18. Supply.participant.participantRole.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueMANU
19. Supply.participant.participantRole.id
Definition

The device ID, e.g. using UDI, is represented by the id element of the participant role. This element is optional, as not all production identifiers (e.g., serial number, lot/batch number, distinct identification number.html) may be known to the provider or patient.

Control0..*
Must Supporttrue
20. Supply.participant.participantRole.playingDevice
Definition

The playingDevice element describes the device instance. 

Control1..1
Must Supporttrue
21. Supply.participant.participantRole.playingDevice.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDEV
22. Supply.participant.participantRole.playingDevice.determinerCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
23. Supply.participant.participantRole.playingDevice.code
Definition

The device code describes the type of device (e.g. arm prosthesis, arterial stent.html).

Control1..1
BindingThe codes SHOULD be taken from Absent or Unknown Devices Absent or Unknown Device
Must Supporttrue

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

1. Supply
Definition

The element shall be present. The moodCode attribute shall be EVN to reflect that a medical device has been provided.

Base definition for all types defined in FHIR type system.

Control0..*
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
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.
Default ValueSPLY
Fixed ValueSPLY
3. Supply.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
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
Must Supporttrue
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.
Fixed Value2.16.840.1.113883.10.22.4.26
7. Supply.id
Definition

This optional element identifies the provision of the device (e.g. implant procedure.html)

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
8. Supply.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Must Supporttrue
9. Supply.text.reference
Definition

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.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Must Supporttrue
10. Supply.text.reference.value
Definition

Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
11. Supply.effectiveTime
Definition

This element provides the interval of time corresponding to the device usage by/presence in the patient.

Control1..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/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXCM-TS
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
XML RepresentationThe type of this property is determined using the xsi:type attribute.
12. Supply.participant
Definition

The device is represented as a participant in the supply structure. The following descriptions apply to the device structure.

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Must Supporttrue
13. Supply.participant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDEV
14. Supply.participant.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole
Must Supporttrue
15. Supply.participant.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueROL
Fixed ValueMANU
16. Supply.participant.participantRole.id
Definition

The device ID, e.g. using UDI, is represented by the id element of the participant role. This element is optional, as not all production identifiers (e.g., serial number, lot/batch number, distinct identification number.html) may be known to the provider or patient.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
17. Supply.participant.participantRole.playingDevice
Definition

The playingDevice element describes the device instance. 

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Device
Must Supporttrue
18. Supply.participant.participantRole.playingDevice.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassDevice
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDEV
Fixed ValueDEV
19. Supply.participant.participantRole.playingDevice.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
20. Supply.participant.participantRole.playingDevice.code
Definition

The device code describes the type of device (e.g. arm prosthesis, arterial stent.html).

Control1..1
BindingThe codes SHOULD be taken from Absent or Unknown Devices Absent or Unknown Device
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue

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

1. Supply
Definition

The element shall be present. The moodCode attribute shall be EVN to reflect that a medical device has been provided.

Control0..*
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
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.
Default ValueSPLY
Fixed ValueSPLY
3. Supply.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
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
Must Supporttrue
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.
Fixed Value2.16.840.1.113883.10.22.4.26
12. Supply.templateId:primary.extension
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. Supply.id
Definition

This optional element identifies the provision of the device (e.g. implant procedure.html)

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
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
Must Supporttrue
16. Supply.text.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.
17. Supply.text.charset
Definition

For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
18. Supply.text.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..1
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
19. Supply.text.integrityCheck
Definition

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.

Control0..1
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
20. Supply.text.integrityCheckAlgorithm
Definition

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.

Control0..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
21. Supply.text.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
22. Supply.text.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
23. Supply.text.representation
Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
24. Supply.text.data[x]
Definition

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.)

Control0..1
TypeChoice of: string, base64Binary
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
25. Supply.text.reference
Definition

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.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Must Supporttrue
26. Supply.text.reference.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.
27. Supply.text.reference.value
Definition

Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
28. Supply.text.reference.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
29. Supply.text.reference.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Control0..*
BindingThe codes SHALL be taken from AddressUse
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
30. Supply.text.thumbnail
Definition

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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
31. Supply.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
32. Supply.effectiveTime
Definition

This element provides the interval of time corresponding to the device usage by/presence in the patient.

Control1..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/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXCM-TS
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
XML RepresentationThe type of this property is determined using the xsi:type attribute.
33. Supply.effectiveTime.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
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
34. Supply.effectiveTime.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.effectiveTime.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
35. 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
36. Supply.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
37. Supply.independentInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
38. Supply.quantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
39. Supply.expectedUseTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
40. 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()))
41. 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
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
42. 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
43. 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
44. Supply.product.manufacturedProduct
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct
45. 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()))
46. 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
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
47. 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
48. 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
49. 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
50. 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
51. Supply.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
52. Supply.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
53. Supply.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
54. Supply.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
55. 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()))
56. 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
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
57. 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
58. 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
59. 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
60. Supply.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
61. Supply.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
62. Supply.participant
Definition

The device is represented as a participant in the supply structure. The following descriptions apply to the device structure.

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Must Supporttrue
63. Supply.participant.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.
64. Supply.participant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDEV
65. Supply.participant.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
66. Supply.participant.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
67. Supply.participant.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
68. Supply.participant.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
69. Supply.participant.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.
70. Supply.participant.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
71. Supply.participant.awarenessCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
72. Supply.participant.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole
Must Supporttrue
73. Supply.participant.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueROL
Fixed ValueMANU
74. Supply.participant.participantRole.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
75. Supply.participant.participantRole.id
Definition

The device ID, e.g. using UDI, is represented by the id element of the participant role. This element is optional, as not all production identifiers (e.g., serial number, lot/batch number, distinct identification number.html) may be known to the provider or patient.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
76. Supply.participant.participantRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
77. Supply.participant.participantRole.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
78. Supply.participant.participantRole.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
79. Supply.participant.participantRole.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
80. Supply.participant.participantRole.playingDevice
Definition

The playingDevice element describes the device instance. 

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Device
Must Supporttrue
81. Supply.participant.participantRole.playingDevice.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassDevice
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDEV
Fixed ValueDEV
82. Supply.participant.participantRole.playingDevice.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
83. Supply.participant.participantRole.playingDevice.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
84. Supply.participant.participantRole.playingDevice.code
Definition

The device code describes the type of device (e.g. arm prosthesis, arterial stent.html).

Control1..1
BindingThe codes SHOULD be taken from Absent or Unknown Devices Absent or Unknown Device
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
85. Supply.participant.participantRole.playingDevice.manufacturerModelName
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-ManufacturerModelName; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/SC
86. Supply.participant.participantRole.playingDevice.softwareName
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-SoftwareName; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/SC
87. Supply.participant.participantRole.playingEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
88. Supply.participant.participantRole.scopingEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Entity
89. 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)
90. 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
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
91. 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
92. Supply.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
93. Supply.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
94. Supply.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
95. Supply.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
96. Supply.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
97. Supply.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
98. Supply.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
99. Supply.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
100. Supply.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
101. Supply.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
102. Supply.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
103. Supply.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
104. Supply.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
105. Supply.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
106. Supply.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
107. 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()))
108. 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
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
109. 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
110. Supply.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
111. Supply.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
112. Supply.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
113. Supply.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
114. Supply.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
115. Supply.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
116. Supply.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition