Polaris FHIR Implementation Guide - Local Development build (v1.10.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: Polaris EMR Device Core
| Official URL: https://fhir.apps.health/StructureDefinition/polaris-core-emrdevice | Version: 1.10.0 | |||
| Draft as of 2026-05-26 | Computable Name: PolarisCoreEmrDevice | |||
Represents an EMR software application/product, capturing key details like manufacturer, product name/model, type, version, and the owning organization using standard Polaris references. Uses a non-instance-specific identifier for the Device itself.
Polaris Core EmrDevice Profile
Overview
The Polaris Core EmrDevice profile represents Electronic Medical Record (EMR) software systems within the Polaris ecosystem. Based on the FHIR Device resource, this profile captures essential metadata about EMR applications including vendor, product name, version, and ownership information for integration and data provenance tracking.
Key Features
- Vendor Identification: Tracks EMR manufacturer/vendor information
- Product Documentation: Captures commercial product names and models
- Version Management: Records software version for compatibility tracking
- Ownership Attribution: Links EMR to operating organization
- Software Classification: Explicitly identifies devices as software systems
Purpose and Use Cases
The EmrDevice profile supports:
- Data Provenance: Tracking which EMR system generated clinical data
- Integration Management: Understanding source system capabilities
- Compatibility Checking: Version-based feature availability
- Audit Trails: Documenting data sources and transformations
- Multi-vendor Environments: Managing heterogeneous EMR landscapes
EMR Metadata Components
Essential elements include:
- Manufacturer: Vendor company name (Epic, Cerner, etc.)
- Device Name: Commercial product name or model
- Type: Fixed as "software" to distinguish from hardware
- Version: Software version string for compatibility
- Owner: Healthcare organization operating the EMR
Integration Scenarios
The profile enables:
- Source system identification in data exchanges
- EMR capability discovery
- Version-specific data mapping
- Vendor-specific integration logic
- Multi-tenant environment management
Data Quality and Governance
Supports tracking of:
- Data lineage from source EMRs
- Version-specific data quality issues
- Vendor-specific data patterns
- Integration points and interfaces
- Compliance with EMR standards
Relationships
EmrDevice connects to:
- Organization: The healthcare entity operating the EMR
- AppState: Application state and session information
- Clinical Resources: As metadata for data provenance
- AuditEvent: For tracking EMR-related activities
Technical Considerations
Important aspects:
- Non-instance-specific identifiers for EMR products
- Version strings may follow vendor-specific formats
- Multiple instances may exist for multi-site deployments
- Supports both commercial and custom EMR systems
Future Considerations
Potential enhancements being evaluated:
- EMR module and feature tracking
- Certification status (e.g., ONC certified)
- Integration capability declarations
- Performance characteristics
- Downtime and maintenance windows
- API versioning information
Usages:
- This Profile is not used by any profiles in this Implementation Guide
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Device |
C | 0..* | Device | Polaris EMR Device Core Constraints: emrdevice-has-polaris-id |
  id |
SΣ | 0..1 | id | Logical id of this artifact |
  meta |
Σ | 0..1 | Meta | Metadata about the resource |
  source |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier |
S | 1..* | Identifier | Business identifier(s) for emrdevice Slice: Unordered, Open by pattern:system |
  identifier:polarisId |
S | 1..1 | Identifier | Polaris EmrDevice ID |
  use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
| system |
Σ | 1..1 | uri | Polaris device identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-device-identifier Example General: http://www.acme.com/identifiers/patient |
 value |
Σ | 1..1 | string | The actual Polaris emrdevice ID value: unique in source system Example General: 123456 |
 identifier:rawCode |
S | 0..* | Identifier | Source EMR emrdevice identifier |
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary |
| system |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-device-raw-code Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
| manufacturer |
S | 1..1 | string | EMR vendor name |
| deviceName |
S | 1..1 | BackboneElement | EMR product name |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
S | 1..1 | string | The actual product name |
| type |
S | 1..1 | code | Type of device name Binding: DeviceNameType (required): The type of name the device is referred by. |
| type |
S | 1..1 | CodeableConcept | Device type - always 'software' Binding: DeviceType (example): Codes to identify medical devices. |
| text |
Σ | 0..1 | string | Plain text representation of the concept Fixed Value: software |
| version |
S | 1..1 | BackboneElement | EMR software version information |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value |
S | 1..1 | string | Version string |
 owner |
S | 1..1 | Reference(Polaris Organization Core) | Organization that owns/operates the EMR |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Device.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Device.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1From the FHIR Standard | |
| Device.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1From the FHIR Standard | |
| Device.type | example | DeviceTypehttp://hl7.org/fhir/ValueSet/device-typeFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Device | If 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-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| emrdevice-has-polaris-id | error | Device | Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-device-identifier$')) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Device |
C | 0..* | Device | Polaris EMR Device Core Constraints: emrdevice-has-polaris-id |
 id |
S | 0..1 | id | Logical id of this artifact |
| meta |
||||
| source |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
| text |
S | 0..1 | Narrative | Narrative |
| Slices for identifier |
S | 1..* | Identifier | Business identifier(s) for emrdevice Slice: Unordered, Open by pattern:system |
| identifier:polarisId |
S | 1..1 | Identifier | Polaris EmrDevice ID |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| system |
1..1 | uri | Polaris device identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-device-identifier | |
| value |
1..1 | string | The actual Polaris emrdevice ID value: unique in source system | |
| identifier:rawCode |
S | 0..* | Identifier | Source EMR emrdevice identifier |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: secondary | |
| system |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-device-raw-code | |
| value |
1..1 | string | The value that is unique | |
| manufacturer |
S | 1..1 | string | EMR vendor name |
| deviceName |
S | 1..1 | BackboneElement | EMR product name |
| name |
S | 1..1 | string | The actual product name |
| type |
S | 1..1 | code | Type of device name |
| type |
S | 1..1 | CodeableConcept | Device type - always 'software' |
| text |
0..1 | string | Plain text representation of the concept Fixed Value: software | |
| version |
S | 1..1 | BackboneElement | EMR software version information |
| value |
S | 1..1 | string | Version string |
| owner |
S | 1..1 | Reference(Polaris Organization Core) | Organization that owns/operates the EMR |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| emrdevice-has-polaris-id | error | Device | Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-device-identifier$')) |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Device |
C | 0..* | Device | Polaris EMR Device Core Constraints: emrdevice-has-polaris-id | ||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
S | 1..* | Identifier | Business identifier(s) for emrdevice Slice: Unordered, Open by pattern:system | ||||
| identifier:polarisId |
S | 1..1 | Identifier | Polaris EmrDevice ID | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | Polaris device identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-device-identifier Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The actual Polaris emrdevice ID value: unique in source system Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:rawCode |
S | 0..* | Identifier | Source EMR emrdevice identifier | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-device-raw-code Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| definition |
0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |||||
| udiCarrier |
Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| deviceIdentifier |
Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
| issuer |
0..1 | uri | UDI Issuing Organization | |||||
| jurisdiction |
0..1 | uri | Regional UDI authority | |||||
| carrierAIDC |
Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
| carrierHRF |
Σ | 0..1 | string | UDI Human Readable Barcode String | ||||
| entryType |
0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
| statusReason |
0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||
| distinctIdentifier |
0..1 | string | The distinct identification string | |||||
| manufacturer |
S | 1..1 | string | EMR vendor name | ||||
| manufactureDate |
0..1 | dateTime | Date when the device was made | |||||
| expirationDate |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |||||
| lotNumber |
0..1 | string | Lot number of manufacture | |||||
| serialNumber |
0..1 | string | Serial number assigned by the manufacturer | |||||
| deviceName |
S | 1..1 | BackboneElement | EMR product name | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
S | 1..1 | string | The actual product name | ||||
| type |
S | 1..1 | code | Type of device name Binding: DeviceNameType (required): The type of name the device is referred by. | ||||
| modelNumber |
0..1 | string | The model number for the device | |||||
| partNumber |
0..1 | string | The part number of the device | |||||
| type |
S | 1..1 | CodeableConcept | Device type - always 'software' Binding: DeviceType (example): Codes to identify medical devices. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept Fixed Value: software | ||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| systemType |
1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||
| version |
0..1 | string | The version of the standard that is used to operate and communicate | |||||
| version |
S | 1..1 | BackboneElement | EMR software version information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
0..1 | CodeableConcept | The type of the device version | |||||
| component |
0..1 | Identifier | A single component of the device version | |||||
| value |
S | 1..1 | string | Version string | ||||
| property |
0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
| valueQuantity |
0..* | Quantity | Property value as a quantity | |||||
| valueCode |
0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
| patient |
0..1 | Reference(Patient) | Patient to whom Device is affixed | |||||
| owner |
S | 1..1 | Reference(Polaris Organization Core) | Organization that owns/operates the EMR | ||||
| contact |
0..* | ContactPoint | Details for human/organization for support | |||||
| location |
0..1 | Reference(Location) | Where the device is found | |||||
| url |
0..1 | uri | Network address to contact device | |||||
| note |
0..* | Annotation | Device notes and comments | |||||
| safety |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
| parent |
0..1 | Reference(Device) | The parent device | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| Device.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Device.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Device.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Device.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Device.identifier:polarisId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Device.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Device.identifier:rawCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Device.udiCarrier.entryType | required | UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1From the FHIR Standard | ||||
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1From the FHIR Standard | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReasonhttp://hl7.org/fhir/ValueSet/device-status-reasonFrom the FHIR Standard | ||||
| Device.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1From the FHIR Standard | ||||
| Device.type | example | DeviceTypehttp://hl7.org/fhir/ValueSet/device-typeFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Device | If 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-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| emrdevice-has-polaris-id | error | Device | Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-device-identifier$')) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Device
Summary
Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 14 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Device.identifier
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Device |
C | 0..* | Device | Polaris EMR Device Core Constraints: emrdevice-has-polaris-id |
| id |
SΣ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| source |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
S | 1..* | Identifier | Business identifier(s) for emrdevice Slice: Unordered, Open by pattern:system |
| identifier:polarisId |
S | 1..1 | Identifier | Polaris EmrDevice ID |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
| system |
Σ | 1..1 | uri | Polaris device identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-device-identifier Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The actual Polaris emrdevice ID value: unique in source system Example General: 123456 |
| identifier:rawCode |
S | 0..* | Identifier | Source EMR emrdevice identifier |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary |
| system |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-device-raw-code Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
| manufacturer |
S | 1..1 | string | EMR vendor name |
| deviceName |
S | 1..1 | BackboneElement | EMR product name |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
S | 1..1 | string | The actual product name |
| type |
S | 1..1 | code | Type of device name Binding: DeviceNameType (required): The type of name the device is referred by. |
| type |
S | 1..1 | CodeableConcept | Device type - always 'software' Binding: DeviceType (example): Codes to identify medical devices. |
| text |
Σ | 0..1 | string | Plain text representation of the concept Fixed Value: software |
| version |
S | 1..1 | BackboneElement | EMR software version information |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value |
S | 1..1 | string | Version string |
| owner |
S | 1..1 | Reference(Polaris Organization Core) | Organization that owns/operates the EMR |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Device.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Device.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1From the FHIR Standard | |
| Device.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1From the FHIR Standard | |
| Device.type | example | DeviceTypehttp://hl7.org/fhir/ValueSet/device-typeFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Device | If 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-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| emrdevice-has-polaris-id | error | Device | Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-device-identifier$')) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Device |
C | 0..* | Device | Polaris EMR Device Core Constraints: emrdevice-has-polaris-id |
| id |
S | 0..1 | id | Logical id of this artifact |
| meta |
||||
| source |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
| text |
S | 0..1 | Narrative | Narrative |
| Slices for identifier |
S | 1..* | Identifier | Business identifier(s) for emrdevice Slice: Unordered, Open by pattern:system |
| identifier:polarisId |
S | 1..1 | Identifier | Polaris EmrDevice ID |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| system |
1..1 | uri | Polaris device identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-device-identifier | |
| value |
1..1 | string | The actual Polaris emrdevice ID value: unique in source system | |
| identifier:rawCode |
S | 0..* | Identifier | Source EMR emrdevice identifier |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: secondary | |
| system |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-device-raw-code | |
| value |
1..1 | string | The value that is unique | |
| manufacturer |
S | 1..1 | string | EMR vendor name |
| deviceName |
S | 1..1 | BackboneElement | EMR product name |
| name |
S | 1..1 | string | The actual product name |
| type |
S | 1..1 | code | Type of device name |
| type |
S | 1..1 | CodeableConcept | Device type - always 'software' |
| text |
0..1 | string | Plain text representation of the concept Fixed Value: software | |
| version |
S | 1..1 | BackboneElement | EMR software version information |
| value |
S | 1..1 | string | Version string |
| owner |
S | 1..1 | Reference(Polaris Organization Core) | Organization that owns/operates the EMR |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| emrdevice-has-polaris-id | error | Device | Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-device-identifier$')) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Device |
C | 0..* | Device | Polaris EMR Device Core Constraints: emrdevice-has-polaris-id | ||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
S | 1..* | Identifier | Business identifier(s) for emrdevice Slice: Unordered, Open by pattern:system | ||||
| identifier:polarisId |
S | 1..1 | Identifier | Polaris EmrDevice ID | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | Polaris device identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-device-identifier Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The actual Polaris emrdevice ID value: unique in source system Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:rawCode |
S | 0..* | Identifier | Source EMR emrdevice identifier | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-device-raw-code Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| definition |
0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |||||
| udiCarrier |
Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| deviceIdentifier |
Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
| issuer |
0..1 | uri | UDI Issuing Organization | |||||
| jurisdiction |
0..1 | uri | Regional UDI authority | |||||
| carrierAIDC |
Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
| carrierHRF |
Σ | 0..1 | string | UDI Human Readable Barcode String | ||||
| entryType |
0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
| statusReason |
0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||
| distinctIdentifier |
0..1 | string | The distinct identification string | |||||
| manufacturer |
S | 1..1 | string | EMR vendor name | ||||
| manufactureDate |
0..1 | dateTime | Date when the device was made | |||||
| expirationDate |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |||||
| lotNumber |
0..1 | string | Lot number of manufacture | |||||
| serialNumber |
0..1 | string | Serial number assigned by the manufacturer | |||||
| deviceName |
S | 1..1 | BackboneElement | EMR product name | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
S | 1..1 | string | The actual product name | ||||
| type |
S | 1..1 | code | Type of device name Binding: DeviceNameType (required): The type of name the device is referred by. | ||||
| modelNumber |
0..1 | string | The model number for the device | |||||
| partNumber |
0..1 | string | The part number of the device | |||||
| type |
S | 1..1 | CodeableConcept | Device type - always 'software' Binding: DeviceType (example): Codes to identify medical devices. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept Fixed Value: software | ||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| systemType |
1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||
| version |
0..1 | string | The version of the standard that is used to operate and communicate | |||||
| version |
S | 1..1 | BackboneElement | EMR software version information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
0..1 | CodeableConcept | The type of the device version | |||||
| component |
0..1 | Identifier | A single component of the device version | |||||
| value |
S | 1..1 | string | Version string | ||||
| property |
0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
| valueQuantity |
0..* | Quantity | Property value as a quantity | |||||
| valueCode |
0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
| patient |
0..1 | Reference(Patient) | Patient to whom Device is affixed | |||||
| owner |
S | 1..1 | Reference(Polaris Organization Core) | Organization that owns/operates the EMR | ||||
| contact |
0..* | ContactPoint | Details for human/organization for support | |||||
| location |
0..1 | Reference(Location) | Where the device is found | |||||
| url |
0..1 | uri | Network address to contact device | |||||
| note |
0..* | Annotation | Device notes and comments | |||||
| safety |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
| parent |
0..1 | Reference(Device) | The parent device | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| Device.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Device.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Device.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Device.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Device.identifier:polarisId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Device.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Device.identifier:rawCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Device.udiCarrier.entryType | required | UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1From the FHIR Standard | ||||
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1From the FHIR Standard | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReasonhttp://hl7.org/fhir/ValueSet/device-status-reasonFrom the FHIR Standard | ||||
| Device.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1From the FHIR Standard | ||||
| Device.type | example | DeviceTypehttp://hl7.org/fhir/ValueSet/device-typeFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Device | If 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-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| emrdevice-has-polaris-id | error | Device | Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-device-identifier$')) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Device
Summary
Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 14 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Device.identifier
Other representations of profile: CSV, Excel, Schematron