Argonaut Data Query Implementation Guide Version 1.0.0

This page is part of the Argonaut Data Query Implementation Guide (v1.0.0: Release) based on FHIR R2. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-argo-device

This profile sets minimum expectations for the Device resource to record, search and fetch UDI information associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the Argonaut Device profile:

  • Query for a Patient’s Devices
  • Record a Patient Device
Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Device must have:

  1. a code identifying the type of resource
  2. a UDI string (“udicarrier”)
  3. a patient

Profile specific implementation guidance:

  • none

Examples

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://fhir.org/guides/argonaut/StructureDefinition/argo-device

This profile builds on Device.

This profile was published on Tue Oct 18 00:00:00 AEDT 2016 as a draft by Argonaut Project.

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

Complete Summary of the Mandatory Requirements

  1. A code in Device.type which has an extensible binding to:
  2. One udicarrier string in Device.udicarrier
    • The Human Readable Form (HRF) representation of the barcode string as printed on the packaging of the device SHALL be used. The AIDC representation cannot be conveyed in FHIR, Because of limitations on character sets in XML and the need to round-trip JSON data through XML.
  3. One patient reference in Device.patient
NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*Argonaut 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: IETF BCP-47 (required)
... 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 id from manufacturer, owner, and others
... type S1..1CodeableConceptWhat kind of device this is
Binding: Argonaut Device Types (extensible)
... note 0..*AnnotationDevice notes and comments
... status ?!Σ0..1codeavailable | not-available | entered-in-error
Binding: DeviceStatus (required)
... manufacturer 0..1stringName of device manufacturer
... model 0..1stringModel id assigned by the manufacturer
... version 0..1stringVersion number (i.e. software)
... manufactureDate 0..1dateTimeManufacture date
... expiry 0..1dateTimeDate and time of expiry of this device (if applicable)
... udi S1..1stringFDA mandated Unique Device Identifier
... lotNumber 0..1stringLot number of manufacture
... owner 0..1Reference(Organization)Organization responsible for device
... location 0..1Reference(Location)Where the resource is found
... patient S1..1Reference(Argonaut Patient Profile)If the resource is affixed to a person
... contact 0..*ContactPointDetails for human/organization for support
... url 0..1uriNetwork address to contact device

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. A code in Device.type which has an extensible binding to:
  2. One udicarrier string in Device.udicarrier
    • The Human Readable Form (HRF) representation of the barcode string as printed on the packaging of the device SHALL be used. The AIDC representation cannot be conveyed in FHIR, Because of limitations on character sets in XML and the need to round-trip JSON data through XML.
  3. One patient reference in Device.patient

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*Argonaut 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: IETF BCP-47 (required)
... 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 id from manufacturer, owner, and others
... type S1..1CodeableConceptWhat kind of device this is
Binding: Argonaut Device Types (extensible)
... note 0..*AnnotationDevice notes and comments
... status ?!Σ0..1codeavailable | not-available | entered-in-error
Binding: DeviceStatus (required)
... manufacturer 0..1stringName of device manufacturer
... model 0..1stringModel id assigned by the manufacturer
... version 0..1stringVersion number (i.e. software)
... manufactureDate 0..1dateTimeManufacture date
... expiry 0..1dateTimeDate and time of expiry of this device (if applicable)
... udi S1..1stringFDA mandated Unique Device Identifier
... lotNumber 0..1stringLot number of manufacture
... owner 0..1Reference(Organization)Organization responsible for device
... location 0..1Reference(Location)Where the resource is found
... patient S1..1Reference(Argonaut Patient Profile)If the resource is affixed to a person
... contact 0..*ContactPointDetails for human/organization for support
... url 0..1uriNetwork address to contact device

doco Documentation for this format

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

 

D.4.1.2 Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the Argonaut Data Query implementation guide server for a complete list of supported RESTful operations and search parameters for this IG.

GET /Device?patient=[id]

Example:

GET http://fhir2.healthintersections.com.au/open/Device/argo-udi-1

Support: Mandatory to support search by patient.

Implementation Notes: Search for all implantable device UDIs for a patient. Fetches a bundle of all Device resources for the specified patient (how to search by reference).

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope