International Patient Summary Implementation Guide
1.0.0 - STU 1
International Patient Summary Implementation Guide
1.0.0 - STU 1
This page is part of the International Patient Summary Implementation Guide (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
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.
The official URL for this profile is:
http://hl7.org/fhir/uv/ips/StructureDefinition/DeviceUseStatement-uv-ips
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DeviceUseStatement
Summary
Mandatory: 2 elements
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from DeviceUseStatement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DeviceUseStatement | S | 0..* | DeviceUseStatement | Record of use of a device |
  subject | S | 1..1 | Reference(Patient (IPS)) | Patient using device |
   reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| timing[x] | S | 1..1 | Timing, Period, dateTime | How often the device was used |
 data-absent-reason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
 source | S | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement |
| device | S | 1..1 | Reference(Device (IPS)) | Reference to device used |
 bodySite | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DeviceUseStatement | SI | 0..* | DeviceUseStatement | Record of use of a device |
 id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External identifier for this record |
| basedOn | ΣI | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order |
| status | ?!ΣI | 1..1 | code | active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required) |
| subject | SΣI | 1..1 | Reference(Patient (IPS)) | Patient using device |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| derivedFrom | ΣI | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information |
 timing[x] | SΣI | 1..1 | How often the device was used | |
| timing[x]:All Types | Content/Rules for all Types | |||
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
 data-absent-reason | SI | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
| timingTiming | Timing | |||
| timingPeriod | Period | |||
| timingDateTime | dateTime | |||
| recordedOn | ΣI | 0..1 | dateTime | When statement was recorded |
| source | SΣI | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement |
| device | SΣI | 1..1 | Reference(Device (IPS)) | Reference to device used |
| reasonCode | ΣI | 0..* | CodeableConcept | Why device was used |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) | Why was DeviceUseStatement performed? |
| bodySite | SI | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) |
| note | I | 0..* | Annotation | Addition details (comments, instructions) |
| Documentation for this format | ||||
This structure is derived from DeviceUseStatement
Summary
Mandatory: 2 elements
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from DeviceUseStatement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DeviceUseStatement | S | 0..* | DeviceUseStatement | Record of use of a device |
| subject | S | 1..1 | Reference(Patient (IPS)) | Patient using device |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| timing[x] | S | 1..1 | Timing, Period, dateTime | How often the device was used |
| data-absent-reason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
| source | S | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement |
| device | S | 1..1 | Reference(Device (IPS)) | Reference to device used |
| bodySite | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DeviceUseStatement | SI | 0..* | DeviceUseStatement | Record of use of a device |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External identifier for this record |
| basedOn | ΣI | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order |
| status | ?!ΣI | 1..1 | code | active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required) |
| subject | SΣI | 1..1 | Reference(Patient (IPS)) | Patient using device |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| derivedFrom | ΣI | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information |
| timing[x] | SΣI | 1..1 | How often the device was used | |
| timing[x]:All Types | Content/Rules for all Types | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| data-absent-reason | SI | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
| timingTiming | Timing | |||
| timingPeriod | Period | |||
| timingDateTime | dateTime | |||
| recordedOn | ΣI | 0..1 | dateTime | When statement was recorded |
| source | SΣI | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement |
| device | SΣI | 1..1 | Reference(Device (IPS)) | Reference to device used |
| reasonCode | ΣI | 0..* | CodeableConcept | Why device was used |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) | Why was DeviceUseStatement performed? |
| bodySite | SI | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) |
| note | I | 0..* | Annotation | Addition details (comments, instructions) |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| DeviceUseStatement.language | preferred | CommonLanguages Max Binding: AllLanguages |
| DeviceUseStatement.status | required | DeviceUseStatementStatus |
| DeviceUseStatement.subject.type | extensible | ResourceType |
| DeviceUseStatement.bodySite | example | SNOMEDCTBodyStructures |
| Id | Path | Details | Requirements |
| dom-2 | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | DeviceUseStatement | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | DeviceUseStatement.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceUseStatement.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceUseStatement.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceUseStatement.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceUseStatement.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.subject.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceUseStatement.subject.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceUseStatement.subject.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.subject.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.subject.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.subject.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.derivedFrom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.timing[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.timing[x].extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceUseStatement.timing[x].extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceUseStatement.timing[x].extension:data-absent-reason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceUseStatement.timing[x].extension:data-absent-reason | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceUseStatement.recordedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.device | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceUseStatement.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ Health Level Seven International - Patient Care Work Group. Package hl7.fhir.uv.ips#1.0.0 based on FHIR 4.0.1. Generated 2020-05-19
Links: Table of Contents |
QA Report | Search
| Version History |
|
Propose a change