Australian Base Profiles Implementation Guide
This page is part of the Australian Base IG (v0.9.3: AU Base 1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions 
Raw json
{
"resourceType" : "StructureDefinition",
"id" : "au-device",
"meta" : {
"lastUpdated" : "2018-03-03T06:34:11.248+11:00"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml">
<p>AU Device</p>
</div>"
},
"url" : "http://hl7.org.au/fhir/StructureDefinition/au-device",
"name" : "AUBaseDevice",
"title" : "AU Base Device",
"status" : "draft",
"date" : "2017-09-26T15:50:09+10:00",
"publisher" : "Health Level Seven Australia (Patient Administration WG)",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://hl7.org.au/fhir",
"use" : "work"
}
]
}
],
"description" : "Australian realm Device profile.",
"fhirVersion" : "3.0.1",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/w5",
"name" : "W5 Mapping"
},
{
"identity" : "udi",
"uri" : "http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm",
"name" : "UDI Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "Device",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Device",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Device",
"path" : "Device",
"short" : "A device in an Australian healthcare context",
"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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Device",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-1",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression" : "contained.text.empty()",
"xpath" : "not(parent::f:contained and f:text)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression" : "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath" : "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source" : "DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Device"
},
{
"identity" : "w5",
"map" : "administrative.device"
}
]
},
{
"id" : "Device.id",
"path" : "Device.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id"
}
],
"isSummary" : true
},
{
"id" : "Device.meta",
"path" : "Device.meta",
"short" : "Metadata about the resource",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"isSummary" : true
},
{
"id" : "Device.implicitRules",
"path" : "Device.implicitRules",
"short" : "A set of rules under which this content was created",
"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.",
"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.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isModifier" : true,
"isSummary" : true
},
{
"id" : "Device.language",
"path" : "Device.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"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
}
],
"strength" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id" : "Device.text",
"path" : "Device.text",
"short" : "Text summary of the resource, for human interpretation",
"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.",
"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.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"condition" : [
"dom-1"
],
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "Device.contained",
"path" : "Device.contained",
"short" : "Contained, inline Resources",
"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.",
"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.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Device.extension",
"path" : "Device.extension",
"short" : "Additional Content defined by implementations",
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Device.modifierExtension",
"path" : "Device.modifierExtension",
"short" : "Extensions that cannot be ignored",
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Device.identifier",
"path" : "Device.identifier",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "system"
}
],
"rules" : "open"
},
"short" : "Instance identifier",
"definition" : "Unique instance identifiers assigned to a device by manufacturers other organizations or owners.",
"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.",
"alias" : [
"Serial Number"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Device.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"mapping" : [
{
"identity" : "udi",
"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" : "rim",
"map" : ".id"
},
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "Device.identifier:paid",
"path" : "Device.identifier",
"sliceName" : "paid",
"short" : "PAI-D",
"definition" : "My Health Record (PCEHR) Assigned Identity for Devices (PAI-D) numbers. An identifier for devices which may author documents on behalf of organisations.",
"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.",
"alias" : [
"Serial Number"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"mapping" : [
{
"identity" : "udi",
"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" : "rim",
"map" : ".id"
},
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "Device.identifier:paid.id",
"path" : "Device.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Device.identifier:paid.extension",
"path" : "Device.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional Content defined by implementations",
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Device.identifier:paid.use",
"path" : "Device.identifier.use",
"short" : "usual | official | temp | secondary (If known)",
"definition" : "The purpose of this identifier.",
"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.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Device.identifier:paid.type",
"path" : "Device.identifier.type",
"short" : "PAI-D Identifier Type",
"definition" : "Element describing the type of identifier",
"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.
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.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "required",
"description" : "Local Identifier Type",
"valueSetReference" : {
"reference" : "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Device.identifier:paid.type.id",
"path" : "Device.identifier.type.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Device.identifier:paid.type.extension",
"path" : "Device.identifier.type.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional Content defined by implementations",
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Device.identifier:paid.type.coding",
"path" : "Device.identifier.type.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"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.",
"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,
"max" : "1",
"base" : {
"path" : "CodeableConcept.coding",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.1-8, C*E.10-22"
},
{
"identity" : "rim",
"map" : "union(., ./translation)"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
}
]
},
{
"id" : "Device.identifier:paid.type.coding.id",
"path" : "Device.identifier.type.coding.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Device.identifier:paid.type.coding.extension",
"path" : "Device.identifier.type.coding.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional Content defined by implementations",
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Device.identifier:paid.type.coding.system",
"path" : "Device.identifier.type.coding.system",
"short" : "Identity of the terminology system",
"definition" : "The identification of the code system that defines the meaning of the symbol in the code.",
"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.",
"requirements" : "Need to be unambiguous about the source of the definition of the symbol.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "http://hl7.org.au/fhir/v2/0203",
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "Device.identifier:paid.type.coding.version",
"path" : "Device.identifier.type.coding.version",
"short" : "Version of the system - if relevant",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.version",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "Device.identifier:paid.type.coding.code",
"path" : "Device.identifier.type.coding.code",
"short" : "Symbol in syntax defined by the system",
"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).",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "NDI",
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "Device.identifier:paid.type.coding.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Device.identifier.type.coding.display",
"short" : "Representation defined by the system",
"definition" : "A representation of the meaning of the code in the system, following the rules of the system.",
"requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.2 - but note this is not well followed"
},
{
"identity" : "rim",
"map" : "CV.displayName"
},
{
"identity" : "orim",
"map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id" : "Device.identifier:paid.type.coding.userSelected",
"path" : "Device.identifier.type.coding.userSelected",
"short" : "If this coding was chosen directly by the user",
"definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"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.",
"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,
"max" : "1",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "Sometimes implied by being first"
},
{
"identity" : "rim",
"map" : "CD.codingRationale"
},
{
"identity" : "orim",
"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 ]"
}
]
},
{
"id" : "Device.identifier:paid.type.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Device.identifier.type.text",
"short" : "PAI-D Identifier Type Descriptive Text",
"definition" : "Descriptive text for the identifier type",
"comment" : "Very often the text is the same as a displayName of one of the codings.",
"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,
"max" : "1",
"base" : {
"path" : "CodeableConcept.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"fixedString" : "PAI-D",
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity" : "rim",
"map" : "./originalText[mediaType/code="text/plain"]/data"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}
]
},
{
"id" : "Device.identifier:paid.system",
"path" : "Device.identifier.system",
"short" : "The national namespace for PAI-D numbers.",
"definition" : "This namespace is used for qualified identifiers to represent My Health Record (PCEHR) Assigned Identity for Devices (PAI-D) numbers.",
"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,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "http://ns.electronichealth.net.au/id/pcehr/paid/1.0",
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Device.identifier:paid.value",
"path" : "Device.identifier.value",
"short" : "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.",
"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).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
},
{
"label" : "PAI-D number",
"valueString" : "8003640003999998"
}
],
"maxLength" : 16,
"constraint" : [
{
"key" : "inv-paid-0",
"requirements" : "The PAI-D shall be a 16 digit number.",
"severity" : "error",
"human" : "The identifier shall be an exactly 16 digit number",
"expression" : "matches('^([0-9]{16})$')"
},
{
"key" : "inv-paid-1",
"requirements" : "The PAI-D prefix is 8003640003",
"severity" : "error",
"human" : "The PAI-D prefix is 8003640003",
"expression" : "startsWith('8003640003')"
},
{
"key" : "inv-paid-2",
"requirements" : "The PAI-D Identifier shall pass the Luhn algorithm check",
"severity" : "error",
"human" : "The identifier shall pass the Luhn algorithm check",
"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)"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Device.identifier:paid.period",
"path" : "Device.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Device.identifier:paid.assigner",
"path" : "Device.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Device.udi",
"path" : "Device.udi",
"short" : "Unique Device Identifier (UDI) Barcode string",
"definition" : "[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.udi",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".id and .code"
},
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "Device.udi.id",
"path" : "Device.udi.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Device.udi.extension",
"path" : "Device.udi.extension",
"short" : "Additional Content defined by implementations",
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Device.udi.modifierExtension",
"path" : "Device.udi.modifierExtension",
"short" : "Extensions that cannot be ignored",
"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.",
"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.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Device.udi.deviceIdentifier",
"path" : "Device.udi.deviceIdentifier",
"short" : "Mandatory fixed portion of UDI",
"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.",
"alias" : [
"DI"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.udi.deviceIdentifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "udi",
"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" : "rim",
"map" : "Role.id.extension"
},
{
"identity" : "w5",
"map" : "what"
}
]
},
{
"id" : "Device.udi.name",
"path" : "Device.udi.name",
"short" : "Device Name as appears on UDI label",
"definition" : "Name of device as used in labeling or catalog.",
"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'.",
"alias" : [
"Brand Name"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.udi.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "udi",
"map" : "Propietary/Trade Name of the medical Device as used in the labeling or catalog"
},
{
"identity" : "rim",
"map" : ".displayName"
},
{
"identity" : "w5",
"map" : "what"
}
]
},
{
"id" : "Device.udi.jurisdiction",
"path" : "Device.udi.jurisdiction",
"short" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.udi.jurisdiction",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "Role.scoper"
}
]
},
{
"id" : "Device.udi.carrierHRF",
"path" : "Device.udi.carrierHRF",
"short" : "UDI Human Readable Barcode String",
"definition" : "The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.",
"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.",
"alias" : [
"Human Readable Form"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.udi.carrierHRF",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "udi",
"map" : "A unique device identifier (UDI) on a device label in plain text"
},
{
"identity" : "rim",
"map" : "Role.id.extension"
}
]
},
{
"id" : "Device.udi.carrierAIDC",
"path" : "Device.udi.carrierAIDC",
"short" : "UDI Machine Readable Barcode String",
"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.",
"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.",
"alias" : [
"Automatic Identification and Data Capture"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.udi.carrierAIDC",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "base64Binary"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "udi",
"map" : "A unique device identifier (UDI) on a device label a form that uses automatic identification and data capture (AIDC) technology."
},
{
"identity" : "rim",
"map" : "Role.id.extension"
}
]
},
{
"id" : "Device.udi.issuer",
"path" : "Device.udi.issuer",
"short" : "UDI Issuing Organization",
"definition" : "Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include :
1) GS1:
http://hl7.org/fhir/NamingSystem/gs1-di,
2) HIBCC:
http://hl7.org/fhir/NamingSystem/hibcc-dI,
3) ICCBBA for blood containers:
http://hl7.org/fhir/NamingSystem/iccbba-blood-di,
4) ICCBA for other devices:
http://hl7.org/fhir/NamingSystem/iccbba-other-di.",
"alias" : [
"Barcode System"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.udi.issuer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"mapping" : [
{
"identity" : "udi",
"map" : "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"
},
{
"identity" : "rim",
"map" : "Role.id.root"
}
]
},
{
"id" : "Device.udi.entryType",
"path" : "Device.udi.entryType",
"short" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.udi.entryType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "UDIEntryType"
}
],
"strength" : "required",
"description" : "Codes to identify how UDI data was entered",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/udi-entry-type"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "NA"
}
]
},
{
"id" : "Device.status",
"path" : "Device.status",
"short" : "active | inactive | entered-in-error | unknown",
"definition" : "Status of the Device availability.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.status",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRDeviceStatus"
}
],
"strength" : "required",
"description" : "The availability status of the device.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/device-status"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".statusCode"
},
{
"identity" : "w5",
"map" : "status"
}
]
},
{
"id" : "Device.type",
"path" : "Device.type",
"short" : "What kind of device this is",
"definition" : "Code or identifier to identify a kind of device.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DeviceKind"
}
],
"strength" : "example",
"description" : "Codes to identify medical devices",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/device-kind"
}
},
"mapping" : [
{
"identity" : "udi",
"map" : "Type description using GMDN or other code system"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "w5",
"map" : "what"
}
]
},
{
"id" : "Device.lotNumber",
"path" : "Device.lotNumber",
"short" : "Lot number of manufacture",
"definition" : "Lot number assigned by the manufacturer.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.lotNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "udi",
"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" : "rim",
"map" : ".lotNumberText"
},
{
"identity" : "w5",
"map" : "what"
}
]
},
{
"id" : "Device.manufacturer",
"path" : "Device.manufacturer",
"short" : "Name of device manufacturer",
"definition" : "A name of the manufacturer.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.manufacturer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "udi",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".playedRole[typeCode=MANU].scoper.name"
},
{
"identity" : "w5",
"map" : "what"
}
]
},
{
"id" : "Device.manufactureDate",
"path" : "Device.manufactureDate",
"short" : "Date when the device was made",
"definition" : "The date and time when the device was manufactured.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.manufactureDate",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"mapping" : [
{
"identity" : "udi",
"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" : "rim",
"map" : ".existenceTime.low"
},
{
"identity" : "w5",
"map" : "what"
}
]
},
{
"id" : "Device.expirationDate",
"path" : "Device.expirationDate",
"short" : "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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.expirationDate",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"mapping" : [
{
"identity" : "udi",
"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" : "rim",
"map" : ".expirationTime"
},
{
"identity" : "w5",
"map" : "what"
}
]
},
{
"id" : "Device.model",
"path" : "Device.model",
"short" : "Model id assigned by the manufacturer",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.model",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".playedRole[typeCode=MANU].code"
},
{
"identity" : "w5",
"map" : "what"
}
]
},
{
"id" : "Device.version",
"path" : "Device.version",
"short" : "Version number (i.e. software)",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.version",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".softwareName (included as part)"
},
{
"identity" : "w5",
"map" : "what"
}
]
},
{
"id" : "Device.patient",
"path" : "Device.patient",
"short" : "Associated patient",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.patient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org.au/fhir/StructureDefinition/au-patient"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]"
},
{
"identity" : "w5",
"map" : "who.focus"
}
]
},
{
"id" : "Device.owner",
"path" : "Device.owner",
"short" : "Device owning organisation",
"definition" : "An organization that is responsible for the provision and ongoing maintenance of the device.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.owner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org.au/fhir/StructureDefinition/au-organisation"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".playedRole[typeCode=OWN].scoper"
},
{
"identity" : "w5",
"map" : "who.source"
}
]
},
{
"id" : "Device.contact",
"path" : "Device.contact",
"short" : "Details for human/organization for support",
"definition" : "Contact details for an organization or a particular human that is responsible for the device.",
"comment" : "used for troubleshooting etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Device.contact",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "ContactPoint"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".scopedRole[typeCode=CON].player"
},
{
"identity" : "w5",
"map" : "who.source"
}
]
},
{
"id" : "Device.location",
"path" : "Device.location",
"short" : "Where the resource is found",
"definition" : "The place where the device can be found.",
"requirements" : "Device.location can be used to track device location.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.location",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org.au/fhir/StructureDefinition/au-location"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".playedRole[typeCode=LOCE].scoper"
},
{
"identity" : "w5",
"map" : "where"
}
]
},
{
"id" : "Device.url",
"path" : "Device.url",
"short" : "Network address to contact device",
"definition" : "A network address on which the device may be contacted directly.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Device.url",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".telecom"
},
{
"identity" : "w5",
"map" : "where"
}
]
},
{
"id" : "Device.note",
"path" : "Device.note",
"short" : "Device notes and comments",
"definition" : "Descriptive information, usage information or implantation information that is not captured in an existing element.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Device.note",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Annotation"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".text"
}
]
},
{
"id" : "Device.safety",
"path" : "Device.safety",
"short" : "Safety Characteristics of Device",
"definition" : "Provides additional safety characteristics about a medical device. For example devices containing latex.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Device.safety",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DeviceSafety"
}
],
"strength" : "example",
"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"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "NA"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Device",
"path" : "Device",
"short" : "A device in an Australian healthcare context"
},
{
"id" : "Device.identifier",
"path" : "Device.identifier",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "system"
}
],
"rules" : "open"
}
},
{
"id" : "Device.identifier:paid",
"path" : "Device.identifier",
"sliceName" : "paid",
"short" : "PAI-D",
"definition" : "My Health Record (PCEHR) Assigned Identity for Devices (PAI-D) numbers. An identifier for devices which may author documents on behalf of organisations.",
"max" : "1"
},
{
"id" : "Device.identifier:paid.type",
"path" : "Device.identifier.type",
"short" : "PAI-D Identifier Type",
"definition" : "Element describing the type of identifier",
"min" : 1,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "required",
"description" : "Local Identifier Type",
"valueSetReference" : {
"reference" : "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203"
}
}
},
{
"id" : "Device.identifier:paid.type.coding",
"path" : "Device.identifier.type.coding",
"max" : "1"
},
{
"id" : "Device.identifier:paid.type.coding.system",
"path" : "Device.identifier.type.coding.system",
"min" : 1,
"fixedUri" : "http://hl7.org.au/fhir/v2/0203"
},
{
"id" : "Device.identifier:paid.type.coding.code",
"path" : "Device.identifier.type.coding.code",
"min" : 1,
"fixedCode" : "NDI"
},
{
"id" : "Device.identifier:paid.type.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Device.identifier.type.text",
"short" : "PAI-D Identifier Type Descriptive Text",
"definition" : "Descriptive text for the identifier type",
"min" : 1,
"fixedString" : "PAI-D"
},
{
"id" : "Device.identifier:paid.system",
"path" : "Device.identifier.system",
"short" : "The national namespace for PAI-D numbers.",
"definition" : "This namespace is used for qualified identifiers to represent My Health Record (PCEHR) Assigned Identity for Devices (PAI-D) numbers.",
"min" : 1,
"fixedUri" : "http://ns.electronichealth.net.au/id/pcehr/paid/1.0"
},
{
"id" : "Device.identifier:paid.value",
"path" : "Device.identifier.value",
"min" : 1,
"example" : [
{
"label" : "PAI-D number",
"valueString" : "8003640003999998"
}
],
"maxLength" : 16,
"constraint" : [
{
"key" : "inv-paid-0",
"requirements" : "The PAI-D shall be a 16 digit number.",
"severity" : "error",
"human" : "The identifier shall be an exactly 16 digit number",
"expression" : "matches('^([0-9]{16})$')"
},
{
"key" : "inv-paid-1",
"requirements" : "The PAI-D prefix is 8003640003",
"severity" : "error",
"human" : "The PAI-D prefix is 8003640003",
"expression" : "startsWith('8003640003')"
},
{
"key" : "inv-paid-2",
"requirements" : "The PAI-D Identifier shall pass the Luhn algorithm check",
"severity" : "error",
"human" : "The identifier shall pass the Luhn algorithm check",
"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)"
}
]
},
{
"id" : "Device.patient",
"path" : "Device.patient",
"short" : "Associated patient",
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org.au/fhir/StructureDefinition/au-patient"
}
]
},
{
"id" : "Device.owner",
"path" : "Device.owner",
"short" : "Device owning organisation",
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org.au/fhir/StructureDefinition/au-organisation"
}
]
},
{
"id" : "Device.location",
"path" : "Device.location",
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org.au/fhir/StructureDefinition/au-location"
}
]
}
]
}
}
AU Base © FHIR STU3 (IG Publisher v3.0.1-11917) generated on Fri, Sep 14, 2018 09:24+1000. |
