{
"description": "Australian realm Device profile.",
"_filename": "StructureDefinition-au-device.json",
"package_name": "hl7.fhir.au.base",
"date": "2017-09-26T15:50:09+10:00",
"derivation": "constraint",
"meta": {
"lastUpdated": "2018-03-03T06:34:11.248+11:00"
},
"publisher": "Health Level Seven Australia (Patient Administration WG)",
"fhirVersion": "3.0.1",
"name": "AUBaseDevice",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm",
"name": "UDI Mapping",
"identity": "udi"
} ],
"abstract": false,
"type": "Device",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "AU Base Device",
"package_version": "0.9.3",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "Device",
"min": 0,
"definition": "This resource identifies an instance or 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. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.",
"short": "A device in an Australian healthcare context",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Device",
"identity": "rim"
}, {
"map": "administrative.device",
"identity": "w5"
} ],
"max": "*",
"id": "Device",
"base": {
"max": "*",
"min": 0,
"path": "Device"
}
}, {
"path": "Device.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Device.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Device.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Device.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Device.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Device.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Device.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Device.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Device.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Device.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Device.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Device.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Device.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Device.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Device.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Device.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Device.identifier",
"min": 0,
"definition": "Unique instance identifiers assigned to a device by manufacturers other organizations or owners.",
"short": "Instance identifier",
"mapping": [ {
"map": "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.",
"identity": "udi"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"type": [ {
"code": "Identifier"
} ],
"alias": [ "Serial Number" ],
"max": "*",
"id": "Device.identifier",
"comment": "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. For [UDI](device.html#5.11.3.2.2), this element corresponds to the variable portion of the UDI that identifies the serial number of a specific device. See [UDI mappings](device-mappings.html#udi) for a complete mapping of UDI parts to Device.",
"base": {
"max": "*",
"min": 0,
"path": "Device.identifier"
}
}, {
"path": "Device.identifier",
"min": 0,
"definition": "My Health Record (PCEHR) Assigned Identity for Devices (PAI-D) numbers. An identifier for devices which may author documents on behalf of organisations.",
"short": "PAI-D",
"mapping": [ {
"map": "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.",
"identity": "udi"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"sliceName": "paid",
"alias": [ "Serial Number" ],
"max": "1",
"id": "Device.identifier:paid",
"comment": "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. For [UDI](device.html#5.11.3.2.2), this element corresponds to the variable portion of the UDI that identifies the serial number of a specific device. See [UDI mappings](device-mappings.html#udi) for a complete mapping of UDI parts to Device.",
"base": {
"max": "*",
"min": 0,
"path": "Device.identifier"
}
}, {
"path": "Device.identifier.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Device.identifier:paid.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Device.identifier.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Device.identifier:paid.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Device.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"max": "1",
"id": "Device.identifier:paid.use",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isSummary": true
}, {
"path": "Device.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 1,
"definition": "Element describing the type of identifier",
"short": "PAI-D Identifier Type",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Local Identifier Type",
"valueSetReference": {
"reference": "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203"
}
},
"max": "1",
"id": "Device.identifier:paid.type",
"comment": "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. \n\nWhere 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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"path": "Device.identifier.type.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Device.identifier:paid.type.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Device.identifier.type.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Device.identifier:paid.type.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Device.identifier.type.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "Device.identifier:paid.type.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Device.identifier.type.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Device.identifier:paid.type.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Device.identifier.type.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Device.identifier:paid.type.coding.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Device.identifier.type.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://hl7.org.au/fhir/v2/0203",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Device.identifier:paid.type.coding.system",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Device.identifier.type.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Device.identifier:paid.type.coding.version",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Device.identifier.type.coding.code",
"fixedCode": "NDI",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Device.identifier:paid.type.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Device.identifier.type.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Device.identifier:paid.type.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Device.identifier.type.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Device.identifier:paid.type.coding.userSelected",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Device.identifier.type.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 1,
"definition": "Descriptive text for the identifier type",
"short": "PAI-D Identifier Type Descriptive Text",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"fixedString": "PAI-D",
"id": "Device.identifier:paid.type.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Device.identifier.system",
"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.",
"min": 1,
"definition": "This namespace is used for qualified identifiers to represent My Health Record (PCEHR) Assigned Identity for Devices (PAI-D) numbers.",
"short": "The national namespace for PAI-D numbers.",
"fixedUri": "http://ns.electronichealth.net.au/id/pcehr/paid/1.0",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Device.identifier:paid.system",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "inv-paid-0",
"human": "The identifier shall be an exactly 16 digit number",
"severity": "error",
"expression": "matches('^([0-9]{16})$')",
"requirements": "The PAI-D shall be a 16 digit number."
}, {
"key": "inv-paid-1",
"human": "The PAI-D prefix is 8003640003",
"severity": "error",
"expression": "startsWith('8003640003')",
"requirements": "The PAI-D prefix is 8003640003"
}, {
"key": "inv-paid-2",
"human": "The identifier shall pass the Luhn algorithm check",
"severity": "error",
"expression": "(((select(substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(1,1).toInteger())+(select(substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(3,1).toInteger())+(select(substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(5,1).toInteger())+(select(substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(7,1).toInteger())+(select(substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(9,1).toInteger())+(select(substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(11,1).toInteger())+(select(substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(13,1).toInteger())+(select(substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(15,1).toInteger()))mod 10=0)",
"requirements": "The PAI-D Identifier shall pass the Luhn algorithm check"
} ],
"path": "Device.identifier.value",
"min": 1,
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"short": "The value that is unique",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Device.identifier:paid.value",
"comment": "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](extension-rendered-value.html).",
"maxLength": 16,
"example": [ {
"label": "General",
"valueString": "123456"
}, {
"label": "PAI-D number",
"valueString": "8003640003999998"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"path": "Device.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Device.identifier:paid.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"path": "Device.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Device.identifier:paid.assigner",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Device.udi",
"min": 0,
"definition": "[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.",
"short": "Unique Device Identifier (UDI) Barcode string",
"mapping": [ {
"map": ".id and .code",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "Device.udi",
"comment": "UDI may identify an unique instance of a device, or it may only identify the type of the device. See [UDI mappings](device-mappings.html#udi) for a complete mapping of UDI parts to Device.",
"base": {
"max": "1",
"min": 0,
"path": "Device.udi"
},
"isSummary": true
}, {
"path": "Device.udi.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Device.udi.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Device.udi.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Device.udi.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Device.udi.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Device.udi.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Device.udi.deviceIdentifier",
"min": 0,
"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.",
"short": "Mandatory fixed portion of UDI",
"mapping": [ {
"map": "The device identifier (DI), a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.",
"identity": "udi"
}, {
"map": "Role.id.extension",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "DI" ],
"max": "1",
"id": "Device.udi.deviceIdentifier",
"base": {
"max": "1",
"min": 0,
"path": "Device.udi.deviceIdentifier"
},
"isSummary": true
}, {
"path": "Device.udi.name",
"min": 0,
"definition": "Name of device as used in labeling or catalog.",
"short": "Device Name as appears on UDI label",
"mapping": [ {
"map": "Propietary/Trade Name of the medical Device as used in the labeling or catalog",
"identity": "udi"
}, {
"map": ".displayName",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Brand Name" ],
"max": "1",
"id": "Device.udi.name",
"comment": "Use the `Device.type` for a generic type or kind of device name. Note the [GUDID](http://www.fda.gov/medicaldevices/deviceregulationandguidance/uniquedeviceidentification/globaludidatabasegudid/default.htm) lists the name as the 'Brand Name'.",
"base": {
"max": "1",
"min": 0,
"path": "Device.udi.name"
},
"isSummary": true
}, {
"path": "Device.udi.jurisdiction",
"requirements": "Allows a recipient of a UDI to know which database will contain the UDI-associated metadata.",
"min": 0,
"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.",
"short": "Regional UDI authority",
"mapping": [ {
"map": "Role.scoper",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Device.udi.jurisdiction",
"base": {
"max": "1",
"min": 0,
"path": "Device.udi.jurisdiction"
}
}, {
"path": "Device.udi.carrierHRF",
"min": 0,
"definition": "The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.",
"short": "UDI Human Readable Barcode String",
"mapping": [ {
"map": "A unique device identifier (UDI) on a device label in plain text",
"identity": "udi"
}, {
"map": "Role.id.extension",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Human Readable Form" ],
"max": "1",
"id": "Device.udi.carrierHRF",
"comment": "If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.",
"base": {
"max": "1",
"min": 0,
"path": "Device.udi.carrierHRF"
},
"isSummary": true
}, {
"path": "Device.udi.carrierAIDC",
"min": 0,
"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.",
"short": "UDI Machine Readable Barcode String",
"mapping": [ {
"map": "A unique device identifier (UDI) on a device label a form that uses automatic identification and data capture (AIDC) technology.",
"identity": "udi"
}, {
"map": "Role.id.extension",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"alias": [ "Automatic Identification and Data Capture" ],
"max": "1",
"id": "Device.udi.carrierAIDC",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Device.udi.carrierAIDC"
},
"isSummary": true
}, {
"path": "Device.udi.issuer",
"min": 0,
"definition": "Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include :\n1) GS1: \nhttp://hl7.org/fhir/NamingSystem/gs1-di, \n2) HIBCC:\nhttp://hl7.org/fhir/NamingSystem/hibcc-dI, \n3) ICCBBA for blood containers:\nhttp://hl7.org/fhir/NamingSystem/iccbba-blood-di, \n4) ICCBA for other devices:\nhttp://hl7.org/fhir/NamingSystem/iccbba-other-di.",
"short": "UDI Issuing Organization",
"mapping": [ {
"map": "All UDIs are to be issued under a system operated by an Jurisdiction-accredited issuing agency.\nGS1 DIs: \n http://hl7.org/fhir/NamingSystem/gs1\nHIBCC DIs:\n http://hl7.org/fhir/NamingSystem/hibcc\nICCBBA DIs for blood containers:\n http://hl7.org/fhir/NamingSystem/iccbba-blood\nICCBA DIs for other devices:\n http://hl7.org/fhir/NamingSystem/iccbba-other",
"identity": "udi"
}, {
"map": "Role.id.root",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"alias": [ "Barcode System" ],
"max": "1",
"id": "Device.udi.issuer",
"base": {
"max": "1",
"min": 0,
"path": "Device.udi.issuer"
}
}, {
"path": "Device.udi.entryType",
"requirements": "Supports a way to distinguish hand entered from machine read data.",
"min": 0,
"definition": "A coded entry to indicate how the data was entered.",
"short": "barcode | rfid | manual +",
"mapping": [ {
"map": "NA",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UDIEntryType"
} ],
"description": "Codes to identify how UDI data was entered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/udi-entry-type"
}
},
"max": "1",
"id": "Device.udi.entryType",
"base": {
"max": "1",
"min": 0,
"path": "Device.udi.entryType"
}
}, {
"path": "Device.status",
"min": 0,
"definition": "Status of the Device availability.",
"isModifier": true,
"short": "active | inactive | entered-in-error | unknown",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRDeviceStatus"
} ],
"description": "The availability status of the device.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/device-status"
}
},
"max": "1",
"id": "Device.status",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Device.status"
},
"isSummary": true
}, {
"path": "Device.type",
"min": 0,
"definition": "Code or identifier to identify a kind of device.",
"short": "What kind of device this is",
"mapping": [ {
"map": "Type description using GMDN or other code system",
"identity": "udi"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DeviceKind"
} ],
"description": "Codes to identify medical devices",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/device-kind"
}
},
"max": "1",
"id": "Device.type",
"base": {
"max": "1",
"min": 0,
"path": "Device.type"
}
}, {
"path": "Device.lotNumber",
"min": 0,
"definition": "Lot number assigned by the manufacturer.",
"short": "Lot number of manufacture",
"mapping": [ {
"map": "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.",
"identity": "udi"
}, {
"map": ".lotNumberText",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Device.lotNumber",
"base": {
"max": "1",
"min": 0,
"path": "Device.lotNumber"
}
}, {
"path": "Device.manufacturer",
"min": 0,
"definition": "A name of the manufacturer.",
"short": "Name of device manufacturer",
"mapping": [ {
"map": "N/A",
"identity": "udi"
}, {
"map": ".playedRole[typeCode=MANU].scoper.name",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Device.manufacturer",
"base": {
"max": "1",
"min": 0,
"path": "Device.manufacturer"
}
}, {
"path": "Device.manufactureDate",
"min": 0,
"definition": "The date and time when the device was manufactured.",
"short": "Date when the device was made",
"mapping": [ {
"map": "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”.",
"identity": "udi"
}, {
"map": ".existenceTime.low",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Device.manufactureDate",
"base": {
"max": "1",
"min": 0,
"path": "Device.manufactureDate"
}
}, {
"path": "Device.expirationDate",
"min": 0,
"definition": "The date and time beyond which this device is no longer valid or should not be used (if applicable).",
"short": "Date and time of expiry of this device (if applicable)",
"mapping": [ {
"map": "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”.",
"identity": "udi"
}, {
"map": ".expirationTime",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Device.expirationDate",
"base": {
"max": "1",
"min": 0,
"path": "Device.expirationDate"
}
}, {
"path": "Device.model",
"min": 0,
"definition": "The \"model\" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.",
"short": "Model id assigned by the manufacturer",
"mapping": [ {
"map": ".playedRole[typeCode=MANU].code",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Device.model",
"base": {
"max": "1",
"min": 0,
"path": "Device.model"
}
}, {
"path": "Device.version",
"min": 0,
"definition": "The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.",
"short": "Version number (i.e. software)",
"mapping": [ {
"map": ".softwareName (included as part)",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Device.version",
"base": {
"max": "1",
"min": 0,
"path": "Device.version"
}
}, {
"path": "Device.patient",
"requirements": "If the device is implanted in a patient, then need to associate the device to the patient.",
"min": 0,
"definition": "Patient information, If the device is affixed to a person.",
"short": "Associated patient",
"mapping": [ {
"map": ".playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-patient"
} ],
"max": "1",
"id": "Device.patient",
"base": {
"max": "1",
"min": 0,
"path": "Device.patient"
}
}, {
"path": "Device.owner",
"min": 0,
"definition": "An organization that is responsible for the provision and ongoing maintenance of the device.",
"short": "Device owning organisation",
"mapping": [ {
"map": ".playedRole[typeCode=OWN].scoper",
"identity": "rim"
}, {
"map": "who.source",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-organisation"
} ],
"max": "1",
"id": "Device.owner",
"base": {
"max": "1",
"min": 0,
"path": "Device.owner"
}
}, {
"path": "Device.contact",
"min": 0,
"definition": "Contact details for an organization or a particular human that is responsible for the device.",
"short": "Details for human/organization for support",
"mapping": [ {
"map": ".scopedRole[typeCode=CON].player",
"identity": "rim"
}, {
"map": "who.source",
"identity": "w5"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "Device.contact",
"comment": "used for troubleshooting etc.",
"base": {
"max": "*",
"min": 0,
"path": "Device.contact"
}
}, {
"path": "Device.location",
"requirements": "Device.location can be used to track device location.",
"min": 0,
"definition": "The place where the device can be found.",
"short": "Where the resource is found",
"mapping": [ {
"map": ".playedRole[typeCode=LOCE].scoper",
"identity": "rim"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-location"
} ],
"max": "1",
"id": "Device.location",
"base": {
"max": "1",
"min": 0,
"path": "Device.location"
}
}, {
"path": "Device.url",
"min": 0,
"definition": "A network address on which the device may be contacted directly.",
"short": "Network address to contact device",
"mapping": [ {
"map": ".telecom",
"identity": "rim"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Device.url",
"comment": "If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.",
"base": {
"max": "1",
"min": 0,
"path": "Device.url"
}
}, {
"path": "Device.note",
"min": 0,
"definition": "Descriptive information, usage information or implantation information that is not captured in an existing element.",
"short": "Device notes and comments",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "Device.note",
"base": {
"max": "*",
"min": 0,
"path": "Device.note"
}
}, {
"path": "Device.safety",
"min": 0,
"definition": "Provides additional safety characteristics about a medical device. For example devices containing latex.",
"short": "Safety Characteristics of Device",
"mapping": [ {
"map": "NA",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DeviceSafety"
} ],
"description": "Codes used to identify medical devices safety characterics. These codes are derived in part from the [United States Food and Drug Administration recommendations](http://www.fda.gov/downloads/medicaldevices/deviceregulationandguidance/guidancedocuments/ucm107708.pdf) and are provided here as a suggestive example.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/device-safety"
}
},
"max": "*",
"id": "Device.safety",
"base": {
"max": "*",
"min": 0,
"path": "Device.safety"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "3cd9b18d-cda6-40c6-9de2-4cd1c362411b",
"kind": "resource",
"url": "http://hl7.org.au/fhir/StructureDefinition/au-device",
"version": null,
"differential": {
"element": [ {
"id": "Device",
"path": "Device",
"short": "A device in an Australian healthcare context"
}, {
"id": "Device.identifier",
"path": "Device.identifier",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
}
}, {
"id": "Device.identifier:paid",
"max": "1",
"path": "Device.identifier",
"short": "PAI-D",
"sliceName": "paid",
"definition": "My Health Record (PCEHR) Assigned Identity for Devices (PAI-D) numbers. An identifier for devices which may author documents on behalf of organisations."
}, {
"id": "Device.identifier:paid.type",
"min": 1,
"path": "Device.identifier.type",
"short": "PAI-D Identifier Type",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Local Identifier Type",
"valueSetReference": {
"reference": "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203"
}
},
"definition": "Element describing the type of identifier"
}, {
"id": "Device.identifier:paid.type.coding",
"max": "1",
"path": "Device.identifier.type.coding"
}, {
"id": "Device.identifier:paid.type.coding.system",
"min": 1,
"path": "Device.identifier.type.coding.system",
"fixedUri": "http://hl7.org.au/fhir/v2/0203"
}, {
"id": "Device.identifier:paid.type.coding.code",
"min": 1,
"path": "Device.identifier.type.coding.code",
"fixedCode": "NDI"
}, {
"id": "Device.identifier:paid.type.text",
"min": 1,
"path": "Device.identifier.type.text",
"short": "PAI-D Identifier Type Descriptive Text",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"definition": "Descriptive text for the identifier type",
"fixedString": "PAI-D"
}, {
"id": "Device.identifier:paid.system",
"min": 1,
"path": "Device.identifier.system",
"short": "The national namespace for PAI-D numbers.",
"fixedUri": "http://ns.electronichealth.net.au/id/pcehr/paid/1.0",
"definition": "This namespace is used for qualified identifiers to represent My Health Record (PCEHR) Assigned Identity for Devices (PAI-D) numbers."
}, {
"id": "Device.identifier:paid.value",
"min": 1,
"path": "Device.identifier.value",
"example": [ {
"label": "PAI-D number",
"valueString": "8003640003999998"
} ],
"maxLength": 16,
"constraint": [ {
"key": "inv-paid-0",
"human": "The identifier shall be an exactly 16 digit number",
"severity": "error",
"expression": "matches('^([0-9]{16})$')",
"requirements": "The PAI-D shall be a 16 digit number."
}, {
"key": "inv-paid-1",
"human": "The PAI-D prefix is 8003640003",
"severity": "error",
"expression": "startsWith('8003640003')",
"requirements": "The PAI-D prefix is 8003640003"
}, {
"key": "inv-paid-2",
"human": "The identifier shall pass the Luhn algorithm check",
"severity": "error",
"expression": "(((select(substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(1,1).toInteger())+(select(substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(3,1).toInteger())+(select(substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(5,1).toInteger())+(select(substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(7,1).toInteger())+(select(substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(9,1).toInteger())+(select(substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(11,1).toInteger())+(select(substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(13,1).toInteger())+(select(substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(15,1).toInteger()))mod 10=0)",
"requirements": "The PAI-D Identifier shall pass the Luhn algorithm check"
} ]
}, {
"id": "Device.patient",
"path": "Device.patient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-patient"
} ],
"short": "Associated patient"
}, {
"id": "Device.owner",
"path": "Device.owner",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-organisation"
} ],
"short": "Device owning organisation"
}, {
"id": "Device.location",
"path": "Device.location",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-location"
} ]
} ]
},
"contact": [ {
"telecom": [ {
"use": "work",
"value": "http://hl7.org.au/fhir",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Device"
}