Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: HCIM Respiration AdministeredOxygen AdministrationDevice

A DeviceUseStatement resource as defined by the Dutch HCIM Respiration v3.1(2017EN).

During breathing or respiration, air flows to and from the lungs, where gas exchange occurs, absorbing oxygen from the air into the blood and exhaling carbon dioxide into the air. Observations of spontaneous breathing, usually registered as part of the observation of vital functions.

Purpose of HCIM

Observing a person’s spontaneous breathing, including recording breathing frequency, depth and rhythm, is done to gain an indication of the health condition of the patient’s pulmonary system.

Purpose of this profile

This profile can be used to register the use of an external device for oxygen administration. It is complemented by the zib-Respiration-AdministeredOxygen-AdministrationDevice profile to record the actual device, and can refer to the zib-Respiration profile via .reasonReference.

Usage:

• Examples for this Resource Profile: DeviceUseStatement/zib-respiration-administeredoxygen-administrationdevice-01

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Zib MedicalDevice

Name	Flags	Card.	Type	Description & Constraints
DeviceUseStatement		0..*	Zib MedicalDevice	AdministrationDevice
extension:reasonReference		0..*	Extension	Extension
valueReference:valueReference		0..1	Reference(HCIM Respiration)	Value of extension
device		1..1	Reference(HCIM Respiration AdministeredOxygen AdministrationDeviceProduct)	Reference to device used
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DeviceUseStatement		0..*	Zib MedicalDevice	AdministrationDevice
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
HealthcareProvider		0..1	Reference(nl-core-organization)	HealthcareProvider URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Organization
HealthProfessional		0..1	(Complex)	HealthProfessional URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Practitioner
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Practitioner"
Slices for value[x]		0..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference		0..1	Reference()	HealthProfessional
extension:reasonReference		0..*	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
Slices for value[x]		0..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference		0..1	Reference(HCIM Respiration)	Value of extension
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 a the Device Usage
subject		1..1	Reference(Group | nl-core-patient)	Patient using device
device		1..1	Reference(HCIM Respiration AdministeredOxygen AdministrationDeviceProduct)	Reference to device used
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DeviceUseStatement.status	required	DeviceUseStatementStatus http://hl7.org/fhir/ValueSet/device-statement-status from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	DeviceUseStatement	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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..*	Zib MedicalDevice	AdministrationDevice
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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
HealthcareProvider		0..1	Reference(nl-core-organization)	HealthcareProvider URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Organization
HealthProfessional		0..1	(Complex)	HealthProfessional URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Practitioner
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Practitioner"
Slices for value[x]		0..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference		0..1	Reference()	HealthProfessional
extension:reasonReference		0..*	Extension	Extension
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
Slices for value[x]		0..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference		0..1	Reference(HCIM Respiration)	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	External identifier for this record
status	?!Σ	1..1	code	active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of a the Device Usage
subject		1..1	Reference(Group | nl-core-patient)	Patient using device
whenUsed		0..1	Period	Time range defined by start and end date/time
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	StartDate
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
timing[x]		0..1		How often the device was used
timingTiming			Timing
timingPeriod			Period
timingDateTime			dateTime
recordedOn		0..1	dateTime	When statement was recorded
source		0..1	Reference(nl-core-patient | nl-core-practitioner | nl-core-relatedperson)	Who made the statement
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
device		1..1	Reference(HCIM Respiration AdministeredOxygen AdministrationDeviceProduct)	Reference to device used
indication		0..*	CodeableConcept	Why device was used
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
indication_Problem		0..*	Reference(HCIM Problem)	Indication-Probleem URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Problem
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
bodySite		0..1	CodeableConcept	AnatomicalLocation Binding: HulpmiddelAnatomischeLocatieCodelijst (extensible): Patient’s anatomical location of the medical aid used.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Laterality		0..1	(Complex)	Laterality URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	BodySite qualifier Binding: MedischHulpmiddelLateraliteitCodelijst (extensible): MedicalDeviceLateralityCodelist
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
note		0..*	Annotation	Addition details (comments, instructions)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
author[x]	Σ	0..1		Individual responsible for the annotation
authorReference			Reference(Practitioner | Patient | RelatedPerson)
authorString			string
time	Σ	0..1	dateTime	When the annotation was made
text		1..1	string	Comment
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DeviceUseStatement.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
DeviceUseStatement.status	required	DeviceUseStatementStatus http://hl7.org/fhir/ValueSet/device-statement-status from the FHIR Standard
DeviceUseStatement.bodySite	extensible	HulpmiddelAnatomischeLocatieCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.2--20171231000000 from this IG
DeviceUseStatement.bodySite.extension:Laterality.value[x]:valueCodeableConcept	extensible	MedischHulpmiddelLateraliteitCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.4--20171231000000 from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	DeviceUseStatement	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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 Zib MedicalDevice

Summary

Structures

This structure refers to these other structures:

• HCIM Respiration (http://nictiz.nl/fhir/StructureDefinition/zib-Respiration)
• HCIM Respiration AdministeredOxygen AdministrationDeviceProduct (http://nictiz.nl/fhir/StructureDefinition/zib-Respiration-AdministeredOxygen-AdministrationDeviceProduct)

Differential View

This structure is derived from Zib MedicalDevice

Name	Flags	Card.	Type	Description & Constraints
DeviceUseStatement		0..*	Zib MedicalDevice	AdministrationDevice
extension:reasonReference		0..*	Extension	Extension
valueReference:valueReference		0..1	Reference(HCIM Respiration)	Value of extension
device		1..1	Reference(HCIM Respiration AdministeredOxygen AdministrationDeviceProduct)	Reference to device used
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
DeviceUseStatement		0..*	Zib MedicalDevice	AdministrationDevice
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
HealthcareProvider		0..1	Reference(nl-core-organization)	HealthcareProvider URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Organization
HealthProfessional		0..1	(Complex)	HealthProfessional URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Practitioner
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Practitioner"
Slices for value[x]		0..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference		0..1	Reference()	HealthProfessional
extension:reasonReference		0..*	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
Slices for value[x]		0..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference		0..1	Reference(HCIM Respiration)	Value of extension
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 a the Device Usage
subject		1..1	Reference(Group | nl-core-patient)	Patient using device
device		1..1	Reference(HCIM Respiration AdministeredOxygen AdministrationDeviceProduct)	Reference to device used
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DeviceUseStatement.status	required	DeviceUseStatementStatus http://hl7.org/fhir/ValueSet/device-statement-status from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	DeviceUseStatement	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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..*	Zib MedicalDevice	AdministrationDevice
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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
HealthcareProvider		0..1	Reference(nl-core-organization)	HealthcareProvider URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Organization
HealthProfessional		0..1	(Complex)	HealthProfessional URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Practitioner
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Practitioner"
Slices for value[x]		0..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference		0..1	Reference()	HealthProfessional
extension:reasonReference		0..*	Extension	Extension
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
Slices for value[x]		0..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference		0..1	Reference(HCIM Respiration)	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	External identifier for this record
status	?!Σ	1..1	code	active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of a the Device Usage
subject		1..1	Reference(Group | nl-core-patient)	Patient using device
whenUsed		0..1	Period	Time range defined by start and end date/time
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	StartDate
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
timing[x]		0..1		How often the device was used
timingTiming			Timing
timingPeriod			Period
timingDateTime			dateTime
recordedOn		0..1	dateTime	When statement was recorded
source		0..1	Reference(nl-core-patient | nl-core-practitioner | nl-core-relatedperson)	Who made the statement
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
device		1..1	Reference(HCIM Respiration AdministeredOxygen AdministrationDeviceProduct)	Reference to device used
indication		0..*	CodeableConcept	Why device was used
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
indication_Problem		0..*	Reference(HCIM Problem)	Indication-Probleem URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice-Problem
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
bodySite		0..1	CodeableConcept	AnatomicalLocation Binding: HulpmiddelAnatomischeLocatieCodelijst (extensible): Patient’s anatomical location of the medical aid used.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Laterality		0..1	(Complex)	Laterality URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	BodySite qualifier Binding: MedischHulpmiddelLateraliteitCodelijst (extensible): MedicalDeviceLateralityCodelist
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
note		0..*	Annotation	Addition details (comments, instructions)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
author[x]	Σ	0..1		Individual responsible for the annotation
authorReference			Reference(Practitioner | Patient | RelatedPerson)
authorString			string
time	Σ	0..1	dateTime	When the annotation was made
text		1..1	string	Comment
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DeviceUseStatement.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
DeviceUseStatement.status	required	DeviceUseStatementStatus http://hl7.org/fhir/ValueSet/device-statement-status from the FHIR Standard
DeviceUseStatement.bodySite	extensible	HulpmiddelAnatomischeLocatieCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.2--20171231000000 from this IG
DeviceUseStatement.bodySite.extension:Laterality.value[x]:valueCodeableConcept	extensible	MedischHulpmiddelLateraliteitCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.4--20171231000000 from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	DeviceUseStatement	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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 Zib MedicalDevice

Summary

Structures

This structure refers to these other structures:

• HCIM Respiration (http://nictiz.nl/fhir/StructureDefinition/zib-Respiration)
• HCIM Respiration AdministeredOxygen AdministrationDeviceProduct (http://nictiz.nl/fhir/StructureDefinition/zib-Respiration-AdministeredOxygen-AdministrationDeviceProduct)

Other representations of profile: CSV, Excel, Schematron