International Patient Summary Implementation Guide
1.1.0 - STU 1 Update 1 International flag

This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Device Use Statement (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/DeviceUseStatement-uv-ips Version: 1.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: DeviceUseStatementUvIps

This profile represents the constraints applied to the DeviceUseStatement resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A statement about a device used by or implanted on the patient is described in the patient summary as an instance of a DeviceUseStatement resource constrained by this profile.

This profile constrains the representation of a statement about a medical device used by or impanted on the patient, part of the “Medical Devices” section of the Composition resource representing the international patient summary, as specified by the IPS project of HL7 International.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from DeviceUseStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceUseStatement 0..*DeviceUseStatementRecord of use of a device
... subject S1..1Reference(Patient (IPS))Patient using device
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... timing[x] S1..1Timing, Period, dateTimeHow often the device was used
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... source 0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who made the statement
... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceUseStatement 0..*DeviceUseStatementRecord of use of a device
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeactive | completed | entered-in-error +
Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage.

.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
... timing[x] SΣ1..1How often the device was used
.... timing[x]:All Types Content/Rules for all Types
..... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... timingTimingTiming
.... timingPeriodPeriod
.... timingDateTimedateTime
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who made the statement
... device SΣ1..1Reference(Device (IPS))Reference to device used
... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceUseStatement.statusrequiredDeviceUseStatementStatus
DeviceUseStatement.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceUseStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceUseStatementIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDeviceUseStatementIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorDeviceUseStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceUseStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceUseStatement 0..*DeviceUseStatementRecord of use of a device
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier for this record
... basedOn Σ0..*Reference(ServiceRequest)Fulfills plan, proposal or order
... status ?!Σ1..1codeactive | completed | entered-in-error +
Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage.

... subject SΣ1..1Reference(Patient (IPS))Patient using device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... derivedFrom Σ0..*Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference)Supporting information
... timing[x] SΣ1..1How often the device was used
.... timing[x]:All Types Content/Rules for all Types
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... timingTimingTiming
.... timingPeriodPeriod
.... timingDateTimedateTime
... recordedOn Σ0..1dateTimeWhen statement was recorded
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who made the statement
... device SΣ1..1Reference(Device (IPS))Reference to device used
... reasonCode Σ0..*CodeableConceptWhy device was used
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media)Why was DeviceUseStatement performed?
... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... note 0..*AnnotationAddition details (comments, instructions)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceUseStatement.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DeviceUseStatement.statusrequiredDeviceUseStatementStatus
DeviceUseStatement.subject.typeextensibleResourceType
DeviceUseStatement.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from DeviceUseStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceUseStatement 0..*DeviceUseStatementRecord of use of a device
... subject S1..1Reference(Patient (IPS))Patient using device
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... timing[x] S1..1Timing, Period, dateTimeHow often the device was used
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... source 0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who made the statement
... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceUseStatement 0..*DeviceUseStatementRecord of use of a device
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeactive | completed | entered-in-error +
Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage.

.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
... timing[x] SΣ1..1How often the device was used
.... timing[x]:All Types Content/Rules for all Types
..... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... timingTimingTiming
.... timingPeriodPeriod
.... timingDateTimedateTime
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who made the statement
... device SΣ1..1Reference(Device (IPS))Reference to device used
... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceUseStatement.statusrequiredDeviceUseStatementStatus
DeviceUseStatement.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceUseStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceUseStatementIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDeviceUseStatementIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorDeviceUseStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceUseStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceUseStatement 0..*DeviceUseStatementRecord of use of a device
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier for this record
... basedOn Σ0..*Reference(ServiceRequest)Fulfills plan, proposal or order
... status ?!Σ1..1codeactive | completed | entered-in-error +
Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage.

... subject SΣ1..1Reference(Patient (IPS))Patient using device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... derivedFrom Σ0..*Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference)Supporting information
... timing[x] SΣ1..1How often the device was used
.... timing[x]:All Types Content/Rules for all Types
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... timingTimingTiming
.... timingPeriodPeriod
.... timingDateTimedateTime
... recordedOn Σ0..1dateTimeWhen statement was recorded
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who made the statement
... device SΣ1..1Reference(Device (IPS))Reference to device used
... reasonCode Σ0..*CodeableConceptWhy device was used
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media)Why was DeviceUseStatement performed?
... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... note 0..*AnnotationAddition details (comments, instructions)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceUseStatement.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DeviceUseStatement.statusrequiredDeviceUseStatementStatus
DeviceUseStatement.subject.typeextensibleResourceType
DeviceUseStatement.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron