Skip to content

App Device Profile

Canonical../StructureDefinition/nexus-emr-core-appdevice
Statusdraft · 1.26.0
BaseDevice (constraint)
SourceFSH · JSON

Simple profile for applications that integrate with patient data and require consent tracking. Contains just the essential information: app name, client_id, and basic details.

Elements / Snapshot

The full effective definition: base Device with this profile's constraints applied.

Element Flags Card. Type Description & Constraints
Device 0..* Item used in healthcare
Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, nexus-note-extension-not-where-native
id 0..1 http://hl7.org/fhirpath/System.String Logical id of this artifact i
meta 0..1 Meta Metadata about the resource
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
versionId 0..1 id Version specific identifier i
Invariants: ele-1
lastUpdated 0..1 instant When the resource version last changed i
Invariants: ele-1
source S 0..1 uri Identifies EMR instance & pipeline version the resource came from i
Invariants: ele-1
profile 0..* canonical Profiles this resource claims to conform to i
Invariants: ele-1
security 0..* Coding Security Labels applied to this resource i
Binding: security-labels (extensible)
Invariants: ele-1
tag 0..* Coding Tags applied to this resource i
Binding: common-tags (example)
Invariants: ele-1
implicitRules ?! 0..1 uri A set of rules under which this content was created i
Invariants: ele-1
language 0..1 code Language of the resource content i
Binding: languages (preferred)
Invariants: ele-1
text 0..1 Narrative Text summary of the resource, for human interpretation i
Invariants: ele-1
contained 0..* Resource Contained, inline Resources i
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored i
Invariants: ele-1, ext-1
identifier 0..* Identifier App identifier (include OAuth client_id) i
Invariants: ele-1
definition 0..1 Reference(DeviceDefinition) The reference to the definition for the device
Invariants: ele-1
udiCarrier 0..* BackboneElement Unique Device Identifier (UDI) Barcode string i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
deviceIdentifier 0..1 string Mandatory fixed portion of UDI
Invariants: ele-1
issuer 0..1 uri UDI Issuing Organization
Invariants: ele-1
jurisdiction 0..1 uri Regional UDI authority
Invariants: ele-1
carrierAIDC 0..1 base64Binary UDI Machine Readable Barcode String i
Invariants: ele-1
carrierHRF 0..1 string UDI Human Readable Barcode String i
Invariants: ele-1
entryType 0..1 code barcode | rfid | manual +
Binding: udi-entry-type (required)
Invariants: ele-1
status S ?! 1..1 code active | inactive i
Binding: device-status (required)
Invariants: ele-1
statusReason 0..* CodeableConcept online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
Binding: device-status-reason (extensible)
Invariants: ele-1
distinctIdentifier 0..1 string The distinct identification string i
Invariants: ele-1
manufacturer S 0..1 string App developer/company (optional)
Invariants: ele-1
manufactureDate 0..1 dateTime Date when the device was made
Invariants: ele-1
expirationDate 0..1 dateTime Date and time of expiry of this device (if applicable)
Invariants: ele-1
lotNumber 0..1 string Lot number of manufacture
Invariants: ele-1
serialNumber 0..1 string Serial number assigned by the manufacturer i
Invariants: ele-1
deviceName S 1..1 BackboneElement The name of the device as given by the manufacturer
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
name S 1..1 string Simple app name
Invariants: ele-1
type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: device-nametype (required)
Invariants: ele-1
modelNumber 0..1 string The model number for the device
Invariants: ele-1
partNumber 0..1 string The part number of the device i
Invariants: ele-1
type S 0..1 CodeableConcept Software application type
Binding: device-type (example)
Invariants: ele-1
specialization 0..* BackboneElement The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
systemType 1..1 CodeableConcept The standard that is used to operate and communicate
Invariants: ele-1
version 0..1 string The version of the standard that is used to operate and communicate
Invariants: ele-1
version 0..* BackboneElement The actual design of the device or software version running on the device
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
type 0..1 CodeableConcept The type of the device version
Invariants: ele-1
component 0..1 Identifier A single component of the device version
Invariants: ele-1
value 1..1 string The version text
Invariants: ele-1
property 0..* BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
type 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
Invariants: ele-1
valueQuantity 0..* Quantity Property value as a quantity
Invariants: ele-1
valueCode 0..* CodeableConcept Property value as a code, e.g., NTP4 (synced to NTP)
Invariants: ele-1
patient 0..1 Reference(Patient) Patient to whom Device is affixed
Invariants: ele-1
owner 0..1 Reference(Organization) Organization responsible for device
Invariants: ele-1
contact 0..* ContactPoint Details for human/organization for support i
Invariants: ele-1
location 0..1 Reference(Location) Where the device is found
Invariants: ele-1
url 0..1 uri Network address to contact device i
Invariants: ele-1
note S 0..1 Annotation Brief description of the app
Invariants: ele-1
safety 0..* CodeableConcept Safety Characteristics of Device
Invariants: ele-1
parent 0..1 Reference(Device) The parent device
Invariants: ele-1