International Patient Summary Implementation Guide
2.0.0 -
International Patient Summary Implementation Guide
2.0.0 -
International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/DeviceUseStatement-uv-ips | Version: 2.0.0 | |||
| Standards status: Trial-use Active as of 2024-06-19 | Maturity Level: 3 | 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.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  DeviceUseStatement |
0..* | DeviceUseStatement | Record of use of a device | |||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| status |
?!Σ | 1..1 | code | active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage. | ||||||||
  subject |
SOΣ | 1..1 | Reference(Patient (IPS)) | Patient using device
| ||||||||
  reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
 Slices for timing[x] |
SOΣ | 1..1 | How often the device was used Slice: Unordered, Open by type:$this
| |||||||||
  timingPeriod |
Period | |||||||||||
| timingDateTime |
dateTime | |||||||||||
  timing[x]:timingDateTime |
SOΣ | 0..1 | dateTime | How often the device was used
| ||||||||
| device |
SOΣ | 1..1 | Reference(Device (IPS)) | Reference to device used
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceUseStatement.status | Base | required | DeviceUseStatementStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceUseStatement | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DeviceUseStatement |
||
| subject |
|
|
 reference |
|
|
| Slices for timing[x] |
|
|
| timing[x]:timingDateTime |
|
|
| device |
|
|
| Documentation for this format | ||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DeviceUseStatement |
0..* | DeviceUseStatement | Record of use of a device | |||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | External identifier for this record | ||||||||
| basedOn |
Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | ||||||||
| status |
?!Σ | 1..1 | code | active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage. | ||||||||
| subject |
SOΣ | 1..1 | Reference(Patient (IPS)) | Patient using device
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| derivedFrom |
Σ | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information | ||||||||
| Slices for timing[x] |
SOΣ | 1..1 | How often the device was used Slice: Unordered, Open by type:$this
| |||||||||
| timingPeriod |
Period | |||||||||||
| timingDateTime |
dateTime | |||||||||||
| timing[x]:timingDateTime |
SOΣ | 0..1 | dateTime | How often the device was used
| ||||||||
| recordedOn |
Σ | 0..1 | dateTime | When statement was recorded | ||||||||
| source |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement | ||||||||
| device |
SOΣ | 1..1 | Reference(Device (IPS)) | Reference to device used
| ||||||||
| reasonCode |
Σ | 0..* | CodeableConcept | Why device was used | ||||||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) | Why was DeviceUseStatement performed? | ||||||||
| bodySite |
Σ | 0..1 | CodeableConcept | Target body site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||||||
| note |
0..* | Annotation | Addition details (comments, instructions) | |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DeviceUseStatement |
||
| subject |
|
|
| reference |
|
|
| Slices for timing[x] |
|
|
| timing[x]:timingDateTime |
|
|
| device |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceUseStatement.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DeviceUseStatement.status | Base | required | DeviceUseStatementStatus | 📍4.0.1 | FHIR Std. |
| DeviceUseStatement.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DeviceUseStatement.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceUseStatement | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Mandatory: 2 elements
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DeviceUseStatement |
0..* | DeviceUseStatement | Record of use of a device | |||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| status |
?!Σ | 1..1 | code | active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage. | ||||||||
| subject |
SOΣ | 1..1 | Reference(Patient (IPS)) | Patient using device
| ||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| Slices for timing[x] |
SOΣ | 1..1 | How often the device was used Slice: Unordered, Open by type:$this
| |||||||||
| timingPeriod |
Period | |||||||||||
| timingDateTime |
dateTime | |||||||||||
| timing[x]:timingDateTime |
SOΣ | 0..1 | dateTime | How often the device was used
| ||||||||
| device |
SOΣ | 1..1 | Reference(Device (IPS)) | Reference to device used
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DeviceUseStatement |
||
| subject |
|
|
| reference |
|
|
| Slices for timing[x] |
|
|
| timing[x]:timingDateTime |
|
|
| device |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceUseStatement.status | Base | required | DeviceUseStatementStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceUseStatement | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DeviceUseStatement |
DeviceUseStatement | |||||||||||
| subject |
SO | 1..1 | Reference(Patient (IPS)) | Patient using device
| ||||||||
| reference |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| Slices for timing[x] |
SO | 1..1 | How often the device was used Slice: Unordered, Open by type:$this
| |||||||||
| timingPeriod |
Period | |||||||||||
| timingDateTime |
dateTime | |||||||||||
| timing[x]:timingDateTime |
SO | 0..1 | dateTime | How often the device was used
| ||||||||
| device |
SO | 1..1 | Reference(Device (IPS)) | Reference to device used
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DeviceUseStatement |
||
| subject |
|
|
| reference |
|
|
| Slices for timing[x] |
|
|
| timing[x]:timingDateTime |
|
|
| device |
|
|
| Documentation for this format | ||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DeviceUseStatement |
0..* | DeviceUseStatement | Record of use of a device | |||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | External identifier for this record | ||||||||
| basedOn |
Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | ||||||||
| status |
?!Σ | 1..1 | code | active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage. | ||||||||
| subject |
SOΣ | 1..1 | Reference(Patient (IPS)) | Patient using device
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| derivedFrom |
Σ | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information | ||||||||
| Slices for timing[x] |
SOΣ | 1..1 | How often the device was used Slice: Unordered, Open by type:$this
| |||||||||
| timingPeriod |
Period | |||||||||||
| timingDateTime |
dateTime | |||||||||||
| timing[x]:timingDateTime |
SOΣ | 0..1 | dateTime | How often the device was used
| ||||||||
| recordedOn |
Σ | 0..1 | dateTime | When statement was recorded | ||||||||
| source |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement | ||||||||
| device |
SOΣ | 1..1 | Reference(Device (IPS)) | Reference to device used
| ||||||||
| reasonCode |
Σ | 0..* | CodeableConcept | Why device was used | ||||||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) | Why was DeviceUseStatement performed? | ||||||||
| bodySite |
Σ | 0..1 | CodeableConcept | Target body site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||||||
| note |
0..* | Annotation | Addition details (comments, instructions) | |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DeviceUseStatement |
||
| subject |
|
|
| reference |
|
|
| Slices for timing[x] |
|
|
| timing[x]:timingDateTime |
|
|
| device |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceUseStatement.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DeviceUseStatement.status | Base | required | DeviceUseStatementStatus | 📍4.0.1 | FHIR Std. |
| DeviceUseStatement.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DeviceUseStatement.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceUseStatement | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Mandatory: 2 elements
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Patient Care.
Package hl7.fhir.uv.ips#2.0.0 based on FHIR 4.0.1.
Generated 2025-10-29
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change