Point-of-Care Device Implementation Guide
1.0.0-draft - STU 1 Ballot3 International flag

Point-of-Care Device Implementation Guide, published by HL7 International / Devices. This guide is not an authorized publication; it is the continuous build for version 1.0.0-draft built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/uv-pocd/ and changes regularly. See the Directory of published versions

Extension: Approved Jurisdictions extension - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the approved-jurisdictions extension

See the documentation on how to interpret the contents of this table

0. Extension
Definition

List of regions in which a device or device component is approved to be operated. This corresponds to the ApprovedJurisdictions element from IEEE 11073-10207. This extension is different to Device.udiCarrier.jurisdiction, which identifies the authoritative source for UDI generation.


Optional Extension Element - found in all resources.

ShortApproved jurisdictionsOptional Extensions Element
Control0..1*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
apj-1: When noApprovedJurisdictions is present, there shall be no approvedJurisdiction extensions. (extension('noApprovedJurisdictions').exists() implies extension('approvedJurisdiction').empty())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.extension:approvedJurisdiction
Slice NameapprovedJurisdiction
Definition

National state, territory, or region where the device is approved to be operated. If the list does not contain any entries, then the device or component is not approved for any region.

ShortApproved jurisdictionAdditional content defined by implementations
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Extension.extension:approvedJurisdiction.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "approvedJurisdiction"
}
<url value="approvedJurisdiction"/>
8. Extension.extension:approvedJurisdiction.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..1
TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Extension.extension.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
10. Extension.extension:approvedJurisdiction.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..1
BindingUnless not suitable, these codes SHALL be taken from For codes, see Jurisdiction ValueSet
(extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

Codes for country, country subdivision and region

TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Extension.extension:noApprovedJurisdictions
Slice NamenoApprovedJurisdictions
Definition

Explicit indication that the device has no approved jurisdictions. A value of false signals that the device is not approved for any region, as opposed to the jurisdiction being unknown. When this extension is present, there are no approved jurisdictions (yet).

ShortNo approved jurisdictionsAdditional content defined by implementations
Control0..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Extension.extension:noApprovedJurisdictions.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "noApprovedJurisdictions"
}
<url value="noApprovedJurisdictions"/>
16. Extension.extension:noApprovedJurisdictions.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..1
Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Extension.extension.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
18. Extension.extension:noApprovedJurisdictions.value[x]:valueBoolean
Slice NamevalueBoolean
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..1
Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "valueBoolean" : true
}
<valueBoolean value="true"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions"
}
<url value="http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions"/>
22. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..01
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. Extension
Definition

List of regions in which a device or device component is approved to be operated. This corresponds to the ApprovedJurisdictions element from IEEE 11073-10207. This extension is different to Device.udiCarrier.jurisdiction, which identifies the authoritative source for UDI generation.

ShortApproved jurisdictions
Control0..1
Invariantsapj-1: When noApprovedJurisdictions is present, there shall be no approvedJurisdiction extensions. (extension('noApprovedJurisdictions').exists() implies extension('approvedJurisdiction').empty())
2. Extension.extension
SlicingThis element introduces a set of slices on Extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.extension:approvedJurisdiction
Slice NameapprovedJurisdiction
Definition

National state, territory, or region where the device is approved to be operated. If the list does not contain any entries, then the device or component is not approved for any region.

ShortApproved jurisdiction
Control0..*
6. Extension.extension:approvedJurisdiction.url
Fixed Value
{
  "url" : "approvedJurisdiction"
}
<url value="approvedJurisdiction"/>
8. Extension.extension:approvedJurisdiction.valueCodeableConcept
BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
(extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

Codes for country, country subdivision and region

TypeCodeableConcept
10. Extension.extension:noApprovedJurisdictions
Slice NamenoApprovedJurisdictions
Definition

Explicit indication that the device has no approved jurisdictions. A value of false signals that the device is not approved for any region, as opposed to the jurisdiction being unknown. When this extension is present, there are no approved jurisdictions (yet).

ShortNo approved jurisdictions
Control0..1
12. Extension.extension:noApprovedJurisdictions.url
Fixed Value
{
  "url" : "noApprovedJurisdictions"
}
<url value="noApprovedJurisdictions"/>
14. Extension.extension:noApprovedJurisdictions.valueBoolean
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Fixed Value
{
  "valueBoolean" : true
}
<valueBoolean value="true"/>
16. Extension.url
Fixed Value
{
  "url" : "http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions"
}
<url value="http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions"/>
18. Extension.value[x]
Control0..0

See the documentation on how to interpret the contents of this table

0. Extension
Definition

List of regions in which a device or device component is approved to be operated. This corresponds to the ApprovedJurisdictions element from IEEE 11073-10207. This extension is different to Device.udiCarrier.jurisdiction, which identifies the authoritative source for UDI generation.

ShortApproved jurisdictions
Control0..1
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
apj-1: When noApprovedJurisdictions is present, there shall be no approvedJurisdiction extensions. (extension('noApprovedJurisdictions').exists() implies extension('approvedJurisdiction').empty())
2. Extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Extension.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Extension.extension:approvedJurisdiction
Slice NameapprovedJurisdiction
Definition

National state, territory, or region where the device is approved to be operated. If the list does not contain any entries, then the device or component is not approved for any region.

ShortApproved jurisdiction
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Extension.extension:approvedJurisdiction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
10. Extension.extension:approvedJurisdiction.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
12. Extension.extension:approvedJurisdiction.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "approvedJurisdiction"
}
<url value="approvedJurisdiction"/>
14. Extension.extension:approvedJurisdiction.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..1
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Extension.extension.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
16. Extension.extension:approvedJurisdiction.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..1
BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
(extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

Codes for country, country subdivision and region

TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Extension.extension:noApprovedJurisdictions
Slice NamenoApprovedJurisdictions
Definition

Explicit indication that the device has no approved jurisdictions. A value of false signals that the device is not approved for any region, as opposed to the jurisdiction being unknown. When this extension is present, there are no approved jurisdictions (yet).

ShortNo approved jurisdictions
Control0..1
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Extension.extension:noApprovedJurisdictions.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
22. Extension.extension:noApprovedJurisdictions.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. Extension.extension:noApprovedJurisdictions.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "noApprovedJurisdictions"
}
<url value="noApprovedJurisdictions"/>
26. Extension.extension:noApprovedJurisdictions.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..1
Typeboolean
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Extension.extension.value[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
28. Extension.extension:noApprovedJurisdictions.value[x]:valueBoolean
Slice NamevalueBoolean
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..1
Typeboolean
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "valueBoolean" : true
}
<valueBoolean value="true"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions"
}
<url value="http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions"/>
32. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))