Device | I | | Device | There are no (further) constraints on this element Element IdShort description Item used in healthcare Definition A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Data Type Device Constraints- dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-4: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-3: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-6:A resource should have narrative for robust management
text.`div`.exists() - dom-5:If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
Mappings- rim:Entity. Role, or Act
- rim:Device
|
identifier | | 0..* | Identifier | There are no (further) constraints on this element Element IdShort description Instance identifier Definition Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
Comments The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used.
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- w5:FiveWs.identifier
- rim:.id
- udi:The serial number which is a component of the production identifier (PI), a conditional, variable portion of a UDI. The identifier.type code should be set to “SNO”(Serial Number) and the system left empty.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdShort description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdShort description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdShort description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdShort description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdDevice.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
definition | I | 0..1 | Reference(DeviceDefinition) | There are no (further) constraints on this element Element IdShort description The reference to the definition for the device Definition The reference to the definition for the device.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data Type Reference(DeviceDefinition) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdDevice.definition.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdDevice.definition.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.definition.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.definition.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.definition.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.definition.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.definition.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdDevice.definition.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.definition.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
udiCarrier | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description Unique Device Identifier (UDI) Barcode string Definition Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
Comments UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.identifier
- rim:.id and .code
|
deviceIdentifier | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.udiCarrier.deviceIdentifier Short description Mandatory fixed portion of UDI Alternate names DI Definition The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.what[x]
- rim:Role.id.extension
- udi:The device identifier (DI), a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
|
issuer | | 0..1 | uri | There are no (further) constraints on this element Element IdShort description UDI Issuing Organization Alternate names Barcode System Definition Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include :
- GS1:
http://hl7.org/fhir/NamingSystem/gs1-di,
- HIBCC:
http://hl7.org/fhir/NamingSystem/hibcc-dI,
- ICCBBA for blood containers:
http://hl7.org/fhir/NamingSystem/iccbba-blood-di,
- ICCBA for other devices:
http://hl7.org/fhir/NamingSystem/iccbba-other-di.
Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:Role.id.root
- udi:All UDIs are to be issued under a system operated by an Jurisdiction-accredited issuing agency.
GS1 DIs:
http://hl7.org/fhir/NamingSystem/gs1
HIBCC DIs:
http://hl7.org/fhir/NamingSystem/hibcc
ICCBBA DIs for blood containers:
http://hl7.org/fhir/NamingSystem/iccbba-blood
ICCBA DIs for other devices:
http://hl7.org/fhir/NamingSystem/iccbba-other
|
jurisdiction | | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.udiCarrier.jurisdiction Short description Regional UDI authority Definition The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.
Requirements Allows a recipient of a UDI to know which database will contain the UDI-associated metadata.
Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
carrierAIDC | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element IdDevice.udiCarrier.carrierAIDC Short description UDI Machine Readable Barcode String Alternate names Automatic Identification and Data Capture Definition The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.
Comments The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.
Data Type base64Binary Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:Role.id.extension
- udi:A unique device identifier (UDI) on a device label a form that uses automatic identification and data capture (AIDC) technology.
|
carrierHRF | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.udiCarrier.carrierHRF Short description UDI Human Readable Barcode String Alternate names Human Readable Form Definition The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
Comments If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:Role.id.extension
- udi:A unique device identifier (UDI) on a device label in plain text
|
entryType | | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.udiCarrier.entryType Short description barcode | rfid | manual + Definition A coded entry to indicate how the data was entered.
Requirements Supports a way to distinguish hand entered from machine read data.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type code Binding Codes to identify how UDI data was entered. UDIEntryType (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdShort description active | inactive | entered-in-error | unknown Definition Status of the Device availability.
Comments This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the device (record)as not currently valid.
Data Type code Binding The availability status of the device. FHIRDeviceStatus (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.status
- rim:.statusCode
|
statusReason | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdShort description online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Definition Reason for the dtatus of the Device availability.
Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data Type CodeableConcept Binding The availability status reason of the device. FHIRDeviceStatusReason (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5:FiveWs.status
|
distinctIdentifier | | 0..1 | string | There are no (further) constraints on this element Element IdDevice.distinctIdentifier Short description The distinct identification string Alternate names Distinct Identification Code (DIC) Definition The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
Comments For example, this applies to devices in the United States regulated under Code of Federal Regulation 21CFR§1271.290(c).
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.what[x]
- rim:.lotNumberText
- udi:The lot or batch number within which a device was manufactured - which is a component of the production identifier (PI), a conditional, variable portion of a UDI.
|
manufacturer | | 0..1 | string | There are no (further) constraints on this element Element IdShort description Name of device manufacturer Definition A name of the manufacturer.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.what[x]
- rim:.playedRole[typeCode=MANU].scoper.name
- udi:N/A
|
manufactureDate | | 0..1 | dateTime | There are no (further) constraints on this element Element IdShort description Date when the device was made Definition The date and time when the device was manufactured.
Data Type dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.what[x]
- rim:.existenceTime.low
- udi:The date a specific device was manufactured - which is a component of the production identifier (PI), a conditional, variable portion of a UDI. For FHIR, The datetime syntax must converted to YYYY-MM-DD[THH:MM:SS]. If hour is present, the minutes and seconds should both be set to “00”.
|
expirationDate | | 0..1 | dateTime | There are no (further) constraints on this element Element IdShort description Date and time of expiry of this device (if applicable) Definition The date and time beyond which this device is no longer valid or should not be used (if applicable).
Data Type dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.what[x]
- rim:.expirationTime
- udi:the expiration date of a specific device - which is a component of the production identifier (PI), a conditional, variable portion of a UDI. For FHIR, The datetime syntax must converted to YYYY-MM-DD[THH:MM:SS]. If hour is present, the minutes and seconds should both be set to “00”.
|
lotNumber | | 0..1 | string | There are no (further) constraints on this element Element IdShort description Lot number of manufacture Definition Lot number assigned by the manufacturer.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.what[x]
- rim:.lotNumberText
- udi:The lot or batch number within which a device was manufactured - which is a component of the production identifier (PI), a conditional, variable portion of a UDI.
|
serialNumber | | 0..1 | string | There are no (further) constraints on this element Element IdShort description Serial number assigned by the manufacturer Definition The serial number assigned by the organization when the device was manufactured.
Comments Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.what[x]
- rim:.playedRole[typeCode=MANU].id
|
deviceName | | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description The name of the device as given by the manufacturer Definition This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
name | | 1..1 | string | There are no (further) constraints on this element Element IdShort description The name of the device Alternate names Σ Definition Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | | 1..1 | codeBinding | There are no (further) constraints on this element Element IdShort description udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Definition The type of deviceName.
UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type code Binding The type of name the device is referred by. DeviceNameType (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.what[x]
- rim:.playedRole[typeCode=MANU].code
|
modelNumber | | 0..1 | string | There are no (further) constraints on this element Element IdShort description The model number for the device Definition The model number for the device.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.what[x]
- rim:.softwareName (included as part)
|
partNumber | | 0..1 | string | There are no (further) constraints on this element Element IdShort description The part number of the device Definition The part number of the device.
Comments Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.what[x]
- rim:.playedRole[typeCode=MANU].id
|
type | | 0..1 | CodeableConceptBinding | Element IdShort description The kind or type of device Definition The kind or type of device.
Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data Type CodeableConcept Binding A code from the SNOMED Clinical Terminology UK coding system that describes a type of device. UKCoreDeviceType (preferred)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
|
specialization | | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication Definition The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
systemType | | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdDevice.specialization.systemType Short description The standard that is used to operate and communicate Alternate names Σ Definition The standard that is used to operate and communicate.
Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data Type CodeableConcept Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
|
version | | 0..1 | string | There are no (further) constraints on this element Element IdDevice.specialization.version Short description The version of the standard that is used to operate and communicate Definition The version of the standard that is used to operate and communicate.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
version | | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description The actual design of the device or software version running on the device Definition The actual design of the device or software version running on the device.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdShort description The type of the device version Alternate names Σ Definition The type of the device version.
Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data Type CodeableConcept Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
|
component | | 0..1 | Identifier | There are no (further) constraints on this element Element IdShort description A single component of the device version Definition A single component of the device version.
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- w5:FiveWs.what[x]
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.version.component.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.version.component.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.version.component.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.version.component.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.version.component.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdDevice.version.component.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
value | | 1..1 | string | There are no (further) constraints on this element Element IdShort description The version text Definition Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
property | | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties Definition The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdShort description Code that specifies the property DeviceDefinitionPropetyCode (Extensible) Definition Code that specifies the property DeviceDefinitionPropetyCode (Extensible).
Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data Type CodeableConcept Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
|
valueQuantity | I | 0..* | Quantity | There are no (further) constraints on this element Element IdDevice.property.valueQuantity Short description Property value as a quantity Definition Property value as a quantity.
Comments The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Data Type Quantity Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - qty-3:If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
Mappings- rim:n/a
- v2:SN (see also Range) or CQ
- rim:PQ, IVL<PQ>, MO, CO, depending on the values
|
valueCode | | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdDevice.property.valueCode Short description Property value as a code, e.g., NTP4 (synced to NTP) Definition Property value as a code, e.g., NTP4 (synced to NTP).
Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data Type CodeableConcept Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
|
patient | I | 0..1 | Reference(UK Core Patient) | Element IdShort description Patient to whom Device is affixed Definition Patient information, If the device is affixed to a person.
Requirements If the device is implanted in a patient, then need to associate the device to the patient.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data Type Reference(UK Core Patient) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5:FiveWs.subject[x]
- rim:.playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]
- w5:FiveWs.subject
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdShort description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdDevice.patient.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.patient.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.patient.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.patient.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.patient.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.patient.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdDevice.patient.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
owner | I | 0..1 | Reference(UK Core Organization) | Element IdShort description Organization responsible for device Definition An organization that is responsible for the provision and ongoing maintenance of the device.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5:FiveWs.source
- rim:.playedRole[typeCode=OWN].scoper
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdShort description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdShort description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.owner.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.owner.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.owner.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.owner.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.owner.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdDevice.owner.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
contact | I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdShort description Details for human/organization for support Definition Contact details for an organization or a particular human that is responsible for the device.
Comments used for troubleshooting etc.
Data Type ContactPoint Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2:A system is required if a value is provided.
value.empty() or system.exists()
Mappings- rim:n/a
- v2:XTN
- rim:TEL
- servd:ContactPoint
- w5:FiveWs.source
- rim:.scopedRole[typeCode=CON].player
|
location | I | 0..1 | Reference(UK Core Location) | Element IdShort description Where the device is found Definition The place where the device can be found.
Requirements Device.location can be used to track device location.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data Type Reference(UK Core Location) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5:FiveWs.where[x]
- rim:.playedRole[typeCode=LOCE].scoper
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdDevice.location.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdDevice.location.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.location.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.location.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.location.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.location.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.location.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdDevice.location.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
url | | 0..1 | uri | There are no (further) constraints on this element Element IdShort description Network address to contact device Definition A network address on which the device may be contacted directly.
Comments If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.where[x]
- rim:.telecom
|
note | | 0..* | Annotation | There are no (further) constraints on this element Element IdShort description Device notes and comments Definition Descriptive information, usage information or implantation information that is not captured in an existing element.
Comments For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
Data Type Annotation Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Act
- rim:.text
|
author[x] | Σ | 0..1 | | There are no (further) constraints on this element Element IdShort description Individual responsible for the annotation Definition The individual responsible for making the annotation.
Comments Organization is used when there's no need for specific attribution as to who made the comment.
Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Act.participant[typeCode=AUT].role
|
authorString | | | string | Data Type string |
authorReference | | | Reference(UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core RelatedPerson) | Data Type Reference(UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core RelatedPerson) |
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdShort description When the annotation was made Definition Indicates when this particular annotation was made.
Data Type dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Act.effectiveTime
|
text | Σ | 1..1 | markdown | There are no (further) constraints on this element Element IdShort description The annotation - text content (as markdown) Definition The text of the annotation in markdown format.
Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
Data Type markdown Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Act.text
|
safety | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdShort description Safety Characteristics of Device Definition Provides additional safety characteristics about a medical device. For example devices containing latex.
Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data Type CodeableConcept Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:NA
|
parent | I | 0..1 | Reference(UK Core Device) | Element IdShort description The parent device Definition Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data Type Reference(UK Core Device) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdShort description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdShort description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.parent.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.parent.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.parent.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.parent.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.parent.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdDevice.parent.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |