International Patient Summary Implementation Guide Implementation Guide Release 0.1.0

This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. 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 STU3. 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 AEDT 2018 as a draft by HL7 International.

This profile builds on Device


Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device
... identifier ..1
.... use ..0
.... type
..... text ..0
.... system ..0
.... value
.... period ..0
.... assigner ..0
... type Slice: Unordered, Open by value:coding.system
.... coding coding-uv-ips
... type Binding: IPSMedicalDevices (required)
... type Binding: IPSMedicalDevices (preferred)
... manufactureDate
... expirationDate
... patient 1..
... owner ..0
... contact ..0
... location ..0
... url ..0
... note ..0
... safety ..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device I0..*Item used in healthcare
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ΣI0..1idLogical id of this artifact
ele-1: All FHIR elements must have a @value or children
... meta ΣI0..1MetaMetadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language I0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
ele-1: All FHIR elements must have a @value or children
... text I0..1NarrativeText summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... contained 0..*ResourceContained, inline Resources
... identifier I0..1IdentifierInstance identifier
ele-1: All FHIR elements must have a @value or children
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
ele-1: All FHIR elements must have a @value or children
..... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
..... coding ΣI0..*CodingCode defined by a terminology system
ele-1: All FHIR elements must have a @value or children
...... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
...... code ΣI0..1codeSymbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: SNO
...... display ΣI0..1stringRepresentation defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: serial number
.... value ΣI0..1stringThe value that is unique
ele-1: All FHIR elements must have a @value or children
Example General': 123456
... udi ΣI0..1BackboneElementUnique Device Identifier (UDI) Barcode string
ele-1: All FHIR elements must have a @value or children
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... deviceIdentifier ΣI0..1stringMandatory fixed portion of UDI
ele-1: All FHIR elements must have a @value or children
.... name ΣI0..1stringDevice Name as appears on UDI label
ele-1: All FHIR elements must have a @value or children
.... jurisdiction I0..1uriRegional UDI authority
ele-1: All FHIR elements must have a @value or children
.... carrierHRF ΣI0..1stringUDI Human Readable Barcode String
ele-1: All FHIR elements must have a @value or children
.... carrierAIDC ΣI0..1base64BinaryUDI Machine Readable Barcode String
ele-1: All FHIR elements must have a @value or children
.... issuer I0..1uriUDI Issuing Organization
ele-1: All FHIR elements must have a @value or children
.... entryType I0..1codebarcode | rfid | manual +
Binding: UDIEntryType (required)
ele-1: All FHIR elements must have a @value or children
... status ?!ΣI0..1codeactive | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required)
ele-1: All FHIR elements must have a @value or children
... type ICodeableConceptWhat kind of device this is
Slice: Unordered, Open by value:coding.system
Binding: IPSMedicalDevices (example)
ele-1: All FHIR elements must have a @value or children
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... coding ΣI0..*coding-uv-ipsA reference to a code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
.... text ΣI0..1stringPlain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... type I0..1CodeableConceptWhat kind of device this is
Binding: IPSMedicalDevices (required)
ele-1: All FHIR elements must have a @value or children
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... coding ΣI0..*CodingCode defined by a terminology system
ele-1: All FHIR elements must have a @value or children
.... text ΣI0..1stringPlain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... type I0..1CodeableConceptWhat kind of device this is
Binding: IPSMedicalDevices (preferred)
ele-1: All FHIR elements must have a @value or children
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... coding ΣI0..*CodingCode defined by a terminology system
ele-1: All FHIR elements must have a @value or children
.... text ΣI0..1stringPlain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... lotNumber I0..1stringLot number of manufacture
ele-1: All FHIR elements must have a @value or children
... manufacturer I0..1stringName of device manufacturer
ele-1: All FHIR elements must have a @value or children
... manufactureDate I0..1dateTimeDate when the device was made
ele-1: All FHIR elements must have a @value or children
... expirationDate I0..1dateTimeDate and time of expiry of this device (if applicable)
ele-1: All FHIR elements must have a @value or children
... model I0..1stringModel id assigned by the manufacturer
ele-1: All FHIR elements must have a @value or children
... version I0..1stringVersion number (i.e. software)
ele-1: All FHIR elements must have a @value or children
... patient I1..1Reference(Patient)Patient to whom Device is affixed
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
.... display ΣI0..1stringText alternative for the resource
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

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