StructureDefinition: ehealth-procedurerequest

Introduction

ProcedureRequest is a record of a request for a procedure to be planned, proposed, or performed with or on a patient. Examples of procedures include diagnostic tests/studies, endoscopic procedures, counseling, biopsies, therapies (e.g., physio-, social-, psychological-), (exploratory) surgeries or procedures, exercises, and other clinical interventions. Procedures may be performed by a healthcare professional, a friend or relative or in some cases by the patient themselves.

Scope and Usage

In scope of the eHealth infrastructure ProcedureRequests are used with CarePlans to express actual measurement activities to be performed by a Patient in the context of a CarePlan.

The eHealth profile of ProcedureRequest has the following extensions:

ehealth-reuseCriteria which defines whether resource(s) resulting from conducting the activity, typically measurements or answering of Questionnaire may be reused and if so with which criteria. These are copied from the ActivityDefinition referenced in definition and can subsequently be adjusted to suit the particular Patient context
ehealth-referenceRange can contain one or more reference ranges against which values in measurements (resource(s) resulting from conducting the activity) can be compared. These are copied from the ActivityDefinition referenced in definition and can subsequently be adjusted to suit the particular Patient context
ehealth-sharingPolicy sets a stance on whether publication to national document sharing of the measurements (resource(s) resulting from conducting the activity) shall be allowed or not. The value is copied from the ActivityDefinition referenced in definition and can subsequently be adjusted to suit the particular Patient context.

Formal Views of Profile Content

The official URL for this profile is:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-procedurerequest

This profile builds on ProcedureRequest.

This profile was published on Tue Oct 27 14:11:48 UTC 2020 as a draft by ehealth.sundhed.dk.

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

This structure is derived from ProcedureRequest

Summary

Mandatory: 3 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from ProcedureRequest

Name	Card.	Type	Description & Constraints
ProcedureRequest	0..*	ProcedureRequest	A record of a request for diagnostic investigations, treatments, or operations to be performed.
extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
ehealth-referenceRange	0..*	(Complex)	Provides guide for interpretation URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
ehealth-sharingPolicy	1..1	CodeableConcept	Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy Binding: Measurement Sharing Policies (required)
ehealth-reuseCriteria	0..1	(Complex)	Criteria to be met for reuse of responses to be allowed. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria
definition	1..1	Reference(eHealth ActivityDefinition) {r }	Protocol or definition
basedOn	0..0
replaces	0..0
requisition
assigner	0..1	Reference(eHealth Organization) {r }	Organization that issued id (may be just text)
code	1..1	CodeableConcept	What is being requested/ordered Binding: Activity Definition Code (required)
subject	1..1	Reference(eHealth Patient) {r }	Individual the service is ordered for
context	1..1	Reference(eHealth EpisodeOfCare) {r }	Encounter or Episode during which request was created
requester
agent	1..1	Reference(eHealth Device \| eHealth Practitioner \| eHealth Organization) {r }	Individual making the request
onBehalfOf	0..1	Reference(eHealth Organization) {r }	Organization agent is acting for
performer	0..1	Reference(eHealth Practitioner \| eHealth Organization \| eHealth Patient \| eHealth Device \| eHealth RelatedPerson \| HealthcareService) {r }	Requested perfomer
reasonReference	0..*	Reference(eHealth Condition \| eHealth Observation) {r }	Explanation/Justification for test
supportingInfo	0..*	Reference(Resource) {r }	Additional clinical information
specimen	0..*	Reference(Specimen) {r }	Procedure Samples
note
author[x]	0..1		Individual responsible for the annotation
authorReference		Reference(eHealth Practitioner \| eHealth Patient \| eHealth RelatedPerson)
authorString		string
relevantHistory	0..*	Reference(eHealth Provenance) {r }	Request provenance
Documentation for this format

This structure is derived from ProcedureRequest

Name	Flags	Card.	Type	Description & Constraints
ProcedureRequest		0..*	ProcedureRequest	A record of a request for diagnostic investigations, treatments, or operations to be performed.
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) Max Binding: All Languages
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ehealth-referenceRange		0..*	(Complex)	Provides guide for interpretation URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
ehealth-sharingPolicy		1..1	CodeableConcept	Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy Binding: Measurement Sharing Policies (required)
ehealth-reuseCriteria		0..1	(Complex)	Criteria to be met for reuse of responses to be allowed. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifiers assigned to this order
definition	Σ	1..1	Reference(eHealth ActivityDefinition) {r }	Protocol or definition
requisition	Σ	0..1	Identifier	Composite Request ID
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(eHealth Organization) {r }	Organization that issued id (may be just text)
status	?!Σ	1..1	code	draft \| active \| suspended \| completed \| entered-in-error \| cancelled Binding: RequestStatus (required)
intent	?!Σ	1..1	code	proposal \| plan \| order + Binding: RequestIntent (required)
priority	Σ	0..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required)
doNotPerform	?!Σ	0..1	boolean	True if procedure should not be performed
category	Σ	0..*	CodeableConcept	Classification of procedure Binding: Procedure Category Codes (SNOMED CT) (example)
code	Σ	1..1	CodeableConcept	What is being requested/ordered Binding: Activity Definition Code (required)
subject	Σ	1..1	Reference(eHealth Patient) {r }	Individual the service is ordered for
context	Σ	1..1	Reference(eHealth EpisodeOfCare) {r }	Encounter or Episode during which request was created
occurrence[x]	Σ	0..1		When procedure should occur
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrenceTiming			Timing
asNeeded[x]	Σ	0..1		Preconditions for procedure or diagnostic Binding: SNOMED CT Medication As Needed Reason Codes (example)
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
authoredOn	Σ	0..1	dateTime	Date request signed
requester	Σ	0..1	BackboneElement	Who/what is requesting procedure or diagnostic
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
agent	Σ	1..1	Reference(eHealth Device \| eHealth Practitioner \| eHealth Organization) {r }	Individual making the request
onBehalfOf	Σ	0..1	Reference(eHealth Organization) {r }	Organization agent is acting for
performerType	Σ	0..1	CodeableConcept	Performer role Binding: Participant Roles (example)
performer	Σ	0..1	Reference(eHealth Practitioner \| eHealth Organization \| eHealth Patient \| eHealth Device \| eHealth RelatedPerson \| HealthcareService) {r }	Requested perfomer
reasonCode	Σ	0..*	CodeableConcept	Explanation/Justification for test Binding: Procedure Reason Codes (example)
reasonReference	Σ	0..*	Reference(eHealth Condition \| eHealth Observation) {r }	Explanation/Justification for test
supportingInfo		0..*	Reference(Resource) {r }	Additional clinical information
specimen	Σ	0..*	Reference(Specimen) {r }	Procedure Samples
bodySite	Σ	0..*	CodeableConcept	Location on Body Binding: SNOMED CT Body Structures (example)
note		0..*	Annotation	Comments
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(eHealth Practitioner \| eHealth Patient \| eHealth RelatedPerson)
authorString			string
time	Σ	0..1	dateTime	When the annotation was made
text		1..1	string	The annotation - text content
relevantHistory		0..*	Reference(eHealth Provenance) {r }	Request provenance
Documentation for this format

This structure is derived from ProcedureRequest

Summary

Mandatory: 3 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ProcedureRequest

Name	Card.	Type	Description & Constraints
ProcedureRequest	0..*	ProcedureRequest	A record of a request for diagnostic investigations, treatments, or operations to be performed.
extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
ehealth-referenceRange	0..*	(Complex)	Provides guide for interpretation URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
ehealth-sharingPolicy	1..1	CodeableConcept	Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy Binding: Measurement Sharing Policies (required)
ehealth-reuseCriteria	0..1	(Complex)	Criteria to be met for reuse of responses to be allowed. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria
definition	1..1	Reference(eHealth ActivityDefinition) {r }	Protocol or definition
basedOn	0..0
replaces	0..0
requisition
assigner	0..1	Reference(eHealth Organization) {r }	Organization that issued id (may be just text)
code	1..1	CodeableConcept	What is being requested/ordered Binding: Activity Definition Code (required)
subject	1..1	Reference(eHealth Patient) {r }	Individual the service is ordered for
context	1..1	Reference(eHealth EpisodeOfCare) {r }	Encounter or Episode during which request was created
requester
agent	1..1	Reference(eHealth Device \| eHealth Practitioner \| eHealth Organization) {r }	Individual making the request
onBehalfOf	0..1	Reference(eHealth Organization) {r }	Organization agent is acting for
performer	0..1	Reference(eHealth Practitioner \| eHealth Organization \| eHealth Patient \| eHealth Device \| eHealth RelatedPerson \| HealthcareService) {r }	Requested perfomer
reasonReference	0..*	Reference(eHealth Condition \| eHealth Observation) {r }	Explanation/Justification for test
supportingInfo	0..*	Reference(Resource) {r }	Additional clinical information
specimen	0..*	Reference(Specimen) {r }	Procedure Samples
note
author[x]	0..1		Individual responsible for the annotation
authorReference		Reference(eHealth Practitioner \| eHealth Patient \| eHealth RelatedPerson)
authorString		string
relevantHistory	0..*	Reference(eHealth Provenance) {r }	Request provenance
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ProcedureRequest		0..*	ProcedureRequest	A record of a request for diagnostic investigations, treatments, or operations to be performed.
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) Max Binding: All Languages
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ehealth-referenceRange		0..*	(Complex)	Provides guide for interpretation URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
ehealth-sharingPolicy		1..1	CodeableConcept	Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy Binding: Measurement Sharing Policies (required)
ehealth-reuseCriteria		0..1	(Complex)	Criteria to be met for reuse of responses to be allowed. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifiers assigned to this order
definition	Σ	1..1	Reference(eHealth ActivityDefinition) {r }	Protocol or definition
requisition	Σ	0..1	Identifier	Composite Request ID
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(eHealth Organization) {r }	Organization that issued id (may be just text)
status	?!Σ	1..1	code	draft \| active \| suspended \| completed \| entered-in-error \| cancelled Binding: RequestStatus (required)
intent	?!Σ	1..1	code	proposal \| plan \| order + Binding: RequestIntent (required)
priority	Σ	0..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required)
doNotPerform	?!Σ	0..1	boolean	True if procedure should not be performed
category	Σ	0..*	CodeableConcept	Classification of procedure Binding: Procedure Category Codes (SNOMED CT) (example)
code	Σ	1..1	CodeableConcept	What is being requested/ordered Binding: Activity Definition Code (required)
subject	Σ	1..1	Reference(eHealth Patient) {r }	Individual the service is ordered for
context	Σ	1..1	Reference(eHealth EpisodeOfCare) {r }	Encounter or Episode during which request was created
occurrence[x]	Σ	0..1		When procedure should occur
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrenceTiming			Timing
asNeeded[x]	Σ	0..1		Preconditions for procedure or diagnostic Binding: SNOMED CT Medication As Needed Reason Codes (example)
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
authoredOn	Σ	0..1	dateTime	Date request signed
requester	Σ	0..1	BackboneElement	Who/what is requesting procedure or diagnostic
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
agent	Σ	1..1	Reference(eHealth Device \| eHealth Practitioner \| eHealth Organization) {r }	Individual making the request
onBehalfOf	Σ	0..1	Reference(eHealth Organization) {r }	Organization agent is acting for
performerType	Σ	0..1	CodeableConcept	Performer role Binding: Participant Roles (example)
performer	Σ	0..1	Reference(eHealth Practitioner \| eHealth Organization \| eHealth Patient \| eHealth Device \| eHealth RelatedPerson \| HealthcareService) {r }	Requested perfomer
reasonCode	Σ	0..*	CodeableConcept	Explanation/Justification for test Binding: Procedure Reason Codes (example)
reasonReference	Σ	0..*	Reference(eHealth Condition \| eHealth Observation) {r }	Explanation/Justification for test
supportingInfo		0..*	Reference(Resource) {r }	Additional clinical information
specimen	Σ	0..*	Reference(Specimen) {r }	Procedure Samples
bodySite	Σ	0..*	CodeableConcept	Location on Body Binding: SNOMED CT Body Structures (example)
note		0..*	Annotation	Comments
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(eHealth Practitioner \| eHealth Patient \| eHealth RelatedPerson)
authorString			string
time	Σ	0..1	dateTime	When the annotation was made
text		1..1	string	The annotation - text content
relevantHistory		0..*	Reference(eHealth Provenance) {r }	Request provenance
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ProcedureRequest.language	extensible	Common Languages Max Binding: All Languages
ProcedureRequest.requisition.use	required	IdentifierUse
ProcedureRequest.requisition.type	extensible	Identifier Type Codes
ProcedureRequest.status	required	RequestStatus
ProcedureRequest.intent	required	RequestIntent
ProcedureRequest.priority	required	RequestPriority
ProcedureRequest.category	example	Procedure Category Codes (SNOMED CT)
ProcedureRequest.code	required	ActivityDefinitionCode
ProcedureRequest.asNeeded[x]	example	SNOMED CT Medication As Needed Reason Codes
ProcedureRequest.performerType	example	Participant Roles
ProcedureRequest.reasonCode	example	Procedure Reason Codes
ProcedureRequest.bodySite	example	SNOMED CT Body Structures

Constraints

Id	Path	Details	Requirements
dom-2	ProcedureRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-1	ProcedureRequest	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-4	ProcedureRequest	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-3	ProcedureRequest	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()
ele-1	ProcedureRequest.extension:referenceRange	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	ProcedureRequest.extension:referenceRange	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ProcedureRequest.extension:sharingPolicy	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	ProcedureRequest.extension:sharingPolicy	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ProcedureRequest.extension:reuseCriteria	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	ProcedureRequest.extension:reuseCriteria	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ProcedureRequest.requester	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())