HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1 (Standard for Trial Use)

This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

DeviceProfile

 

The official URL for this profile is: 

http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Device

A specific durable physical device used in diagnosis or treatment. The value is the coding for a type of device, for example, a CPAP machine. The same device might be used on multiple patients.

This profile builds on US Core Device Profile.

This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by HL7.

View the corresponding DeviceModel logical model.

Summary

ODH Mapping Source

This structure represents the following ODH mapping definition:

cimi.entity.Device maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-device:
  Type maps to type
  DeviceUdi maps to udi.carrierHRF
  VendorModelNumber maps to model
  ManufacturerName maps to manufacturer
  ManufactureDate maps to manufactureDate
  ExpirationDate maps to expirationDate
  Version maps to version
  Url maps to url
NameFlagsCard.TypeDescription & Constraintsdoco
.. Device I0..*ODH Device Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierInstance identifier
... udi SΣI1..1BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... deviceIdentifier Σ0..1stringMandatory fixed portion of UDI
.... name Σ0..1stringDevice Name as appears on UDI label
.... jurisdiction 0..1uriRegional UDI authority
.... carrierHRF Σ0..1stringUDI Human Readable Barcode String
.... carrierAIDC Σ0..1base64BinaryUDI Machine Readable Barcode String
.... issuer 0..1uriUDI Issuing Organization
.... entryType 0..1codebarcode | rfid | manual +
Binding: UDIEntryType (required)
... status ?!Σ0..1codeactive | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required)
... type S1..1CodeableConceptWhat kind of device this is
Binding: ODH DeviceVS ValueSet (required)
... lotNumber 0..1stringLot number of manufacture
... manufacturer 0..1stringName of device manufacturer
... manufactureDate 0..1dateTimeDate when the device was made
... expirationDate 0..1dateTimeDate and time of expiry of this device (if applicable)
... model 0..1stringModel id assigned by the manufacturer
... version 0..1stringVersion number (i.e. software)
... patient S1..1Reference(US Core Patient Profile)Patient to whom Device is affixed
... owner 0..1Reference(Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... location 0..1Reference(Location)Where the resource is found
... url 0..1uriNetwork address to contact device
... note 0..*AnnotationDevice notes and comments
... safety Σ0..*CodeableConceptSafety Characteristics of Device
Binding: DeviceSafety (example)

doco Documentation for this format

Summary

ODH Mapping Source

This structure represents the following ODH mapping definition:

cimi.entity.Device maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-device:
  Type maps to type
  DeviceUdi maps to udi.carrierHRF
  VendorModelNumber maps to model
  ManufacturerName maps to manufacturer
  ManufactureDate maps to manufactureDate
  ExpirationDate maps to expirationDate
  Version maps to version
  Url maps to url

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device I0..*ODH Device Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierInstance identifier
... udi SΣI1..1BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... deviceIdentifier Σ0..1stringMandatory fixed portion of UDI
.... name Σ0..1stringDevice Name as appears on UDI label
.... jurisdiction 0..1uriRegional UDI authority
.... carrierHRF Σ0..1stringUDI Human Readable Barcode String
.... carrierAIDC Σ0..1base64BinaryUDI Machine Readable Barcode String
.... issuer 0..1uriUDI Issuing Organization
.... entryType 0..1codebarcode | rfid | manual +
Binding: UDIEntryType (required)
... status ?!Σ0..1codeactive | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required)
... type S1..1CodeableConceptWhat kind of device this is
Binding: ODH DeviceVS ValueSet (required)
... lotNumber 0..1stringLot number of manufacture
... manufacturer 0..1stringName of device manufacturer
... manufactureDate 0..1dateTimeDate when the device was made
... expirationDate 0..1dateTimeDate and time of expiry of this device (if applicable)
... model 0..1stringModel id assigned by the manufacturer
... version 0..1stringVersion number (i.e. software)
... patient S1..1Reference(US Core Patient Profile)Patient to whom Device is affixed
... owner 0..1Reference(Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... location 0..1Reference(Location)Where the resource is found
... url 0..1uriNetwork address to contact device
... note 0..*AnnotationDevice notes and comments
... safety Σ0..*CodeableConceptSafety Characteristics of Device
Binding: DeviceSafety (example)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Device.languageCommon LanguagesextensibleCommon Languages
Device.udi.entryTypeUDIEntryTyperequiredUDIEntryType
Device.statusFHIRDeviceStatusrequiredFHIRDeviceStatus
Device.typeODH DeviceVS ValueSetrequiredDeviceVS
Device.safetyDeviceSafetyexampleDeviceSafety

 

Constraints

IdPathDetailsRequirements
dom-2DeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1DeviceIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4DeviceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3DeviceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1Device.udiAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())