International Patient Summary Implementation Guide Implementation Guide: STU2 Ballot

This page is part of the International Patient Summary Implementation Guide (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

SD.9 StructureDefinition-device-uv-ips

This profile represents the constraints applied to the Device resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A device used by or implanted on the patient is described in the patient summary as an instance of a Device resource constrained by this profile.

Conformance resource variables defined here

SD.9.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/device-uv-ips

Published on Wed Feb 14 00:00:00 AEST 2018 as a draft by HL7 International.

This profile builds on Device

Summary

Mandatory: 1 element (2 nested mandatory elements)
Fixed Value: 3 elements
Prohibited: 14 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Device.type.coding is sliced based on the value of value:Device.type.coding.system

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*
... identifier 0..1Identifier
.... use 0..0
.... type 0..1CodeableConcept
..... text 0..0
.... system 0..0
.... value 0..1string
.... period 0..0
.... assigner 0..0
... manufactureDate 0..1dateTime
... expirationDate 0..1dateTime
... type 0..1CodeableConceptBinding: IPS Medical Devices (preferred)
.... coding coding-uv-ipsSlice: Unordered, Open by value:Device.type.coding.system
.... coding 0..*CodingBinding: IPS Medical Devices (required)
..... system 1..1uriFixed Value: http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown
..... code 1..1code
... patient 1..1Reference(Patient)
... owner 0..0
... contact 0..0
... location 0..0
... url 0..0
... note 0..0
... safety 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device I0..*Item used in 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 (preferred)
... text 0..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..1IdentifierInstance identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: SNO
...... display Σ0..1stringRepresentation defined by the system
Fixed Value: serial number
.... value Σ0..1stringThe value that is unique
Example General': 123456
... definition 0..1Reference(DeviceDefinition)The reference to the definition for the device
... udiCarrier ΣI0..*BackboneElementUnique 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 if unrecognized
.... deviceIdentifier Σ0..1stringMandatory fixed portion of UDI
.... issuer 0..1uriUDI Issuing Organization
.... jurisdiction 0..1uriRegional UDI authority
.... carrierAIDC Σ0..1base64BinaryUDI Machine Readable Barcode String
.... carrierHRF Σ0..1stringUDI Human Readable Barcode String
.... entryType 0..1codebarcode | rfid | manual +
Binding: UDIEntryType (required)
... status ?!Σ0..1codeactive | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required)
... statusReason 0..*CodeableConceptonline | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
Binding: FHIRDeviceStatusReason (extensible)
... distinctIdentificationCode 0..1stringThe distinct identification code for a biological product regulated as a device
... 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)
... lotNumber 0..1stringLot number of manufacture
... serialNumber 0..1stringSerial number assigned by the manufacturer
... deviceName I0..*BackboneElementThe name of the device as given by the manufacturer
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... name 1..1stringThe name of the device
.... type 1..1codeudi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required)
... modelNumber 0..1stringThe model number for the device
... partNumber 0..1stringThe part number of the device
... type 0..1CodeableConceptThe kind or type of device
Binding: IPS Medical Devices (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σcoding-uv-ipsCode defined by a terminology system
Slice: Unordered, Open by value:Device.type.coding.system
.... coding Σ0..*CodingCode defined by a terminology system
Binding: IPS Medical Devices (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... specialization I0..*BackboneElementThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... systemType 1..1CodeableConceptThe standard that is used to operate and communicate
.... version 0..1stringThe version of the standard that is used to operate and communicate
... version I0..*BackboneElementThe actual design of the device or software version running on the device
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... type 0..1CodeableConceptThe type of the device version
.... component 0..1IdentifierA single component of the device version
.... value 1..1stringThe version text
... property I0..*BackboneElementThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... type 1..1CodeableConceptCode that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuanity 0..*QuantityProperty value as a quantity
.... valueCode 0..*CodeableConceptProperty value as a code, e.g., NTP4 (synced to NTP)
... patient 1..1Reference(Patient)Patient to whom Device is affixed
... parent 0..1Reference(Device)The parent device

doco Documentation for this format

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