Australian Patient Summary Implementation Guide
0.0.1 - CI Build
Australian Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HealthIntersections/au-ips/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/ips/StructureDefinition/DeviceUseStatement-au-ips | Version: 0.0.1 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: DeviceUseStatementAuIps |
This profile is based on the UV profile, with Australian rules added as well (by reference to the Australian profile)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DeviceUseStatementUvIps
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceUseStatement | DeviceUseStatementUvIps | |||
subject | 1..1 | Reference(Patient (AU IPS)) | Patient using device | |
device | 1..1 | Reference(Device (AU IPS)) | Reference to device used | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceUseStatement | 0..* | DeviceUseStatementUvIps | 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 | SΣ | 1..1 | Reference(Patient (AU IPS)) | Patient using device |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
timing[x] | SΣ | 1..1 | How often the device was used | |
timing[x]All Types | Content/Rules for all Types | |||
Slices for extension | Content/Rules for all slices | |||
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) |
timingTiming | Timing | |||
timingPeriod | Period | |||
timingDateTime | dateTime | |||
device | SΣ | 1..1 | Reference(Device (AU IPS)) | Reference to device used |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DeviceUseStatement.status | required | DeviceUseStatementStatushttp://hl7.org/fhir/ValueSet/device-statement-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DeviceUseStatement | 0..* | DeviceUseStatementUvIps | 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 | |||||
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 | SΣ | 1..1 | Reference(Patient (AU 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 | SΣ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 | ||||
timing[x] | SΣ | 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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) | ||||
timingTiming | Timing | |||||||
timingPeriod | Period | |||||||
timingDateTime | dateTime | |||||||
recordedOn | Σ | 0..1 | dateTime | When statement was recorded | ||||
source | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement | ||||
device | SΣ | 1..1 | Reference(Device (AU 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
note | 0..* | Annotation | Addition details (comments, instructions) | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
DeviceUseStatement.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DeviceUseStatement.status | required | DeviceUseStatementStatushttp://hl7.org/fhir/ValueSet/device-statement-status|4.0.1 from the FHIR Standard | ||||
DeviceUseStatement.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
DeviceUseStatement.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from DeviceUseStatementUvIps
Summary
Structures
This structure refers to these other structures:
Maturity: 2
Differential View
This structure is derived from DeviceUseStatementUvIps
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceUseStatement | DeviceUseStatementUvIps | |||
subject | 1..1 | Reference(Patient (AU IPS)) | Patient using device | |
device | 1..1 | Reference(Device (AU IPS)) | Reference to device used | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceUseStatement | 0..* | DeviceUseStatementUvIps | 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 | SΣ | 1..1 | Reference(Patient (AU IPS)) | Patient using device |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
timing[x] | SΣ | 1..1 | How often the device was used | |
timing[x]All Types | Content/Rules for all Types | |||
Slices for extension | Content/Rules for all slices | |||
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) |
timingTiming | Timing | |||
timingPeriod | Period | |||
timingDateTime | dateTime | |||
device | SΣ | 1..1 | Reference(Device (AU IPS)) | Reference to device used |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DeviceUseStatement.status | required | DeviceUseStatementStatushttp://hl7.org/fhir/ValueSet/device-statement-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DeviceUseStatement | 0..* | DeviceUseStatementUvIps | 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 | |||||
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 | SΣ | 1..1 | Reference(Patient (AU 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 | SΣ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 | ||||
timing[x] | SΣ | 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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) | ||||
timingTiming | Timing | |||||||
timingPeriod | Period | |||||||
timingDateTime | dateTime | |||||||
recordedOn | Σ | 0..1 | dateTime | When statement was recorded | ||||
source | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement | ||||
device | SΣ | 1..1 | Reference(Device (AU 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
note | 0..* | Annotation | Addition details (comments, instructions) | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
DeviceUseStatement.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DeviceUseStatement.status | required | DeviceUseStatementStatushttp://hl7.org/fhir/ValueSet/device-statement-status|4.0.1 from the FHIR Standard | ||||
DeviceUseStatement.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
DeviceUseStatement.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from DeviceUseStatementUvIps
Summary
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron