Current Build

2.45 Resource ItemInstance - Content

Orders and Observations Work GroupMaturity Level: 0 Draft Compartments: Patient

A physical, countable instance of an item, for example one box or one unit.

This resource has not yet undergone proper review by the appropriate Workgroups. At this time, is considered only as a draft resource proposal for potential submission

Different resources have different ways to handle “physical instances”

  • Lack of clear support and guidance for instance has caused traceability to be a problem in implementations: Standards-guided implementations do not consider “instances” or do so inconsistently.
  • In border cases (medication containing devices), this can cause issues.
  • Inconsistency can also require extensions and further divergence. E.g. for adopting the EU Serialization directive, need to add “serial number” to the medication. What and where is that extension?

If the resources that represent physical entities were split into a "kind" resource and an "instance" resource, this resource would represent the instance that would be referenced by the "kind" resource. For example, Device would be split into Device ( representing the kind or type of Device ) + ItemInstance ( representing the instance of a Device ).

Resources impacted:

  • Substance
  • Medication
  • Device

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ItemInstance ΣDDomainResourceA physical instance of an item
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... count Σ1..1integerThe count of items
... location Σ0..1Reference(Location)The physical location of the item
... subject Σ0..1Reference(Patient)The patient that the item is affixed to
... manufactureDate Σ0..1dateTimeThe manufacture or preparation date and time
... expiryDate Σ0..1dateTimeThe expiry or preparation date and time
... currentSWVersion Σ0..1stringThe Software version associated with the device
... lotNumber Σ0..1stringThe lot or batch number
... serialNumber Σ0..1stringThe serial number if available
... carrierAIDC Σ0..1stringThe machine-readable AIDC string in base64 encoding
... carrierHRF Σ0..1stringThe human-readable barcode string

doco Documentation for this format

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ItemInstance;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ItemInstance.count [ integer ]; # 1..1 The count of items
  fhir:ItemInstance.location [ Reference(Location) ]; # 0..1 The physical location of the item
  fhir:ItemInstance.subject [ Reference(Patient) ]; # 0..1 The patient that the item is affixed to
  fhir:ItemInstance.manufactureDate [ dateTime ]; # 0..1 The manufacture or preparation date and time
  fhir:ItemInstance.expiryDate [ dateTime ]; # 0..1 The expiry or preparation date and time
  fhir:ItemInstance.currentSWVersion [ string ]; # 0..1 The Software version associated with the device
  fhir:ItemInstance.lotNumber [ string ]; # 0..1 The lot or batch number
  fhir:ItemInstance.serialNumber [ string ]; # 0..1 The serial number if available
  fhir:ItemInstance.carrierAIDC [ string ]; # 0..1 The machine-readable AIDC string in base64 encoding
  fhir:ItemInstance.carrierHRF [ string ]; # 0..1 The human-readable barcode string
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ItemInstance ΣDDomainResourceA physical instance of an item
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... count Σ1..1integerThe count of items
... location Σ0..1Reference(Location)The physical location of the item
... subject Σ0..1Reference(Patient)The patient that the item is affixed to
... manufactureDate Σ0..1dateTimeThe manufacture or preparation date and time
... expiryDate Σ0..1dateTimeThe expiry or preparation date and time
... currentSWVersion Σ0..1stringThe Software version associated with the device
... lotNumber Σ0..1stringThe lot or batch number
... serialNumber Σ0..1stringThe serial number if available
... carrierAIDC Σ0..1stringThe machine-readable AIDC string in base64 encoding
... carrierHRF Σ0..1stringThe human-readable barcode string

doco Documentation for this format

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ItemInstance;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ItemInstance.count [ integer ]; # 1..1 The count of items
  fhir:ItemInstance.location [ Reference(Location) ]; # 0..1 The physical location of the item
  fhir:ItemInstance.subject [ Reference(Patient) ]; # 0..1 The patient that the item is affixed to
  fhir:ItemInstance.manufactureDate [ dateTime ]; # 0..1 The manufacture or preparation date and time
  fhir:ItemInstance.expiryDate [ dateTime ]; # 0..1 The expiry or preparation date and time
  fhir:ItemInstance.currentSWVersion [ string ]; # 0..1 The Software version associated with the device
  fhir:ItemInstance.lotNumber [ string ]; # 0..1 The lot or batch number
  fhir:ItemInstance.serialNumber [ string ]; # 0..1 The serial number if available
  fhir:ItemInstance.carrierAIDC [ string ]; # 0..1 The machine-readable AIDC string in base64 encoding
  fhir:ItemInstance.carrierHRF [ string ]; # 0..1 The human-readable barcode string
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
subjectreferenceThe identifier of the patient who has devices assigned toItemInstance.subject
(Patient)