eHealth Infrastructure (v2019.5)

StructureDefinition: ehealth-device

This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.

REST API Examples

Create Device

Create a simple Device resource with manufacturer and model:

POST /hapi-fhir-server/baseDstu3/Device/ 

Content-Type: application/fhir+json

{
    "resourceType": "Device",
    "manufacturer": "Vitalograph",
    "model": "Alpha IV"
}

If this create operation goes well, the server responds with HTTP status 201 Created, and a response like this:

X-FHIR-Request-Validation: No issues detected
Location: http://localhost:31000/hapi-fhir-server/baseDstu3/Device/1955/_history/1
Content-Type: application/fhir+json;charset=utf-8

{
    "resourceType": "Device",
    "id": "1955",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2019-02-27T13:20:12.511+00:00"
    },
    "manufacturer": "Vitalograph",
    "model": "Alpha IV"
}

Create a privately owned Device

Create a Device similar to the above, but using an extension field to mark it as “privately owned”:

POST /hapi-fhir-server/baseDstu3/Device/ HTTP/1.1

Content-Type: application/fhir+json

{
    "resourceType": "Device",
    "extension": [
      {
        "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-privatelyOwned",
        "valueBoolean": true
      }
    ],
    "manufacturer": "Vitalograph",
    "model": "Alpha IV"
}

which yields this response:

X-FHIR-Request-Validation: No issues detected
Location: http://localhost:31000/hapi-fhir-server/baseDstu3/Device/1956/_history/1
Content-Type: application/fhir+json;charset=utf-8

{
  "resourceType": "Device",
  "id": "1956",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2019-02-27T13:26:19.406+00:00"
  },
  "extension": [
    {
      "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-privatelyOwned",
      "valueBoolean": true
    }
  ],
  "manufacturer": "Vitalograph",
  "model": "Alpha IV"
}

Formal Views of Profile Content

The official URL for this profile is: 

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device

This profile builds on Device.

This profile was published on Wed May 08 06:17:13 UTC 2019 as a draft by ehealth.sundhed.dk.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*An instance or a type of a manufactured item that is used in the provision of healthcare.
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... ehealth-device-privatelyOwned 0..1booleanOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-privatelyOwned
... ehealth-device-suppliers 0..*(Complex)Optional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-suppliers
... type 0..1CodeableConceptBinding: DeviceTypes (required)
... patient 0..1Reference(eHealth Patient)
... owner 0..1Reference(eHealth Organization)

doco Documentation for this format

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device I0..*An instance or a type of a manufactured item that is used in the provision of healthcare.
... 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-device-privatelyOwned 0..1booleanExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-privatelyOwned
... ehealth-device-suppliers 0..*(Complex)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-suppliers
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierInstance identifier
... udi ΣI0..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 0..1CodeableConceptWhat kind of device this is
Binding: DeviceTypes (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 0..1Reference(eHealth Patient)Patient to whom Device is affixed
... owner 0..1Reference(eHealth 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
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Reference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson) {r}, stringIndividual responsible for the annotation
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... safety Σ0..*CodeableConceptSafety Characteristics of Device
Binding: DeviceSafety (example)

doco Documentation for this format

Differential View

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*An instance or a type of a manufactured item that is used in the provision of healthcare.
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... ehealth-device-privatelyOwned 0..1booleanOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-privatelyOwned
... ehealth-device-suppliers 0..*(Complex)Optional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-suppliers
... type 0..1CodeableConceptBinding: DeviceTypes (required)
... patient 0..1Reference(eHealth Patient)
... owner 0..1Reference(eHealth Organization)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device I0..*An instance or a type of a manufactured item that is used in the provision of healthcare.
... 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-device-privatelyOwned 0..1booleanExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-privatelyOwned
... ehealth-device-suppliers 0..*(Complex)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-suppliers
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierInstance identifier
... udi ΣI0..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 0..1CodeableConceptWhat kind of device this is
Binding: DeviceTypes (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 0..1Reference(eHealth Patient)Patient to whom Device is affixed
... owner 0..1Reference(eHealth 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
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Reference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson) {r}, stringIndividual responsible for the annotation
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... safety Σ0..*CodeableConceptSafety Characteristics of Device
Binding: DeviceSafety (example)

doco Documentation for this format

 

Terminology Bindings

PathNameConformanceValueSet
Device.languageCommon LanguagesextensibleCommon Languages
Device.udi.entryTypeUDIEntryTyperequiredUDIEntryType
Device.statusFHIRDeviceStatusrequiredFHIRDeviceStatus
Device.typeDeviceTypesrequiredDeviceTypes
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())
.