eHealth Infrastructure (v2019.6.1)

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 Wed Dec 04 13:16:07 UTC 2019 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest 0..*A record of a request for diagnostic investigations, treatments, or operations to be performed.
... extension 0..*ExtensionSlice: 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..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
... 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..1Reference(eHealth ActivityDefinition) {r}
... basedOn 0..0
... replaces 0..0
... requisition
.... assigner 0..1Reference(eHealth Organization) {r}
... code 1..1CodeableConceptBinding: ActivityDefinitionCode (required)
... subject 1..1Reference(eHealth Patient) {r}
... context 1..1Reference(eHealth EpisodeOfCare) {r}
... requester
.... agent 1..1Reference(eHealth Device | eHealth Practitioner | eHealth Organization) {r}
.... onBehalfOf 0..1Reference(eHealth Organization) {r}
... performer 0..1Reference(eHealth Practitioner | eHealth Organization | eHealth Patient | eHealth Device | eHealth RelatedPerson | HealthcareService) {r}
... reasonReference 0..*Reference(eHealth Condition | eHealth Observation) {r}
... supportingInfo 0..*Reference(Resource) {r}
... specimen 0..*Reference(Specimen) {r}
... note
.... author[x] 0..1
..... authorReferenceReference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson)
..... authorStringstring
... relevantHistory 0..*Reference(eHealth Provenance) {r}

doco Documentation for this format

This structure is derived from ProcedureRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest I0..*A record of a request for diagnostic investigations, treatments, or operations to be performed.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-referenceRange I0..*(Complex)Provides guide for interpretation
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
... ehealth-sharingPolicy I1..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
... ehealth-reuseCriteria I0..1(Complex)Criteria to be met for reuse of responses to be allowed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... definition Σ1..1Reference(eHealth ActivityDefinition) {r}Protocol or definition
... requisition Σ0..1IdentifierComposite Request ID
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(eHealth Organization) {r}Organization that issued id (may be just text)
... status ?!Σ1..1codedraft | active | suspended | completed | entered-in-error | cancelled
Binding: RequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order +
Binding: RequestIntent (required)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if procedure should not be performed
... category Σ0..*CodeableConceptClassification of procedure
Binding: Procedure Category Codes (SNOMED CT) (example)
... code Σ1..1CodeableConceptWhat is being requested/ordered
Binding: ActivityDefinitionCode (required)
... subject Σ1..1Reference(eHealth Patient) {r}Individual the service is ordered for
... context Σ1..1Reference(eHealth EpisodeOfCare) {r}Encounter or Episode during which request was created
... occurrence[x] Σ0..1When procedure should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] Σ0..1Preconditions for procedure or diagnostic
Binding: SNOMED CT Medication As Needed Reason Codes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn Σ0..1dateTimeDate request signed
... requester ΣI0..1BackboneElementWho/what is requesting procedure or diagnostic
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent Σ1..1Reference(eHealth Device | eHealth Practitioner | eHealth Organization) {r}Individual making the request
.... onBehalfOf Σ0..1Reference(eHealth Organization) {r}Organization agent is acting for
... performerType Σ0..1CodeableConceptPerformer role
Binding: Participant Roles (example)
... performer Σ0..1Reference(eHealth Practitioner | eHealth Organization | eHealth Patient | eHealth Device | eHealth RelatedPerson | HealthcareService) {r}Requested perfomer
... reasonCode Σ0..*CodeableConceptExplanation/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..*CodeableConceptLocation on Body
Binding: SNOMED CT Body Structures (example)
... note 0..*AnnotationComments
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... relevantHistory 0..*Reference(eHealth Provenance) {r}Request provenance

doco Documentation for this format

Differential View

This structure is derived from ProcedureRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest 0..*A record of a request for diagnostic investigations, treatments, or operations to be performed.
... extension 0..*ExtensionSlice: 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..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
... 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..1Reference(eHealth ActivityDefinition) {r}
... basedOn 0..0
... replaces 0..0
... requisition
.... assigner 0..1Reference(eHealth Organization) {r}
... code 1..1CodeableConceptBinding: ActivityDefinitionCode (required)
... subject 1..1Reference(eHealth Patient) {r}
... context 1..1Reference(eHealth EpisodeOfCare) {r}
... requester
.... agent 1..1Reference(eHealth Device | eHealth Practitioner | eHealth Organization) {r}
.... onBehalfOf 0..1Reference(eHealth Organization) {r}
... performer 0..1Reference(eHealth Practitioner | eHealth Organization | eHealth Patient | eHealth Device | eHealth RelatedPerson | HealthcareService) {r}
... reasonReference 0..*Reference(eHealth Condition | eHealth Observation) {r}
... supportingInfo 0..*Reference(Resource) {r}
... specimen 0..*Reference(Specimen) {r}
... note
.... author[x] 0..1
..... authorReferenceReference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson)
..... authorStringstring
... relevantHistory 0..*Reference(eHealth Provenance) {r}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest I0..*A record of a request for diagnostic investigations, treatments, or operations to be performed.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-referenceRange I0..*(Complex)Provides guide for interpretation
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
... ehealth-sharingPolicy I1..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
... ehealth-reuseCriteria I0..1(Complex)Criteria to be met for reuse of responses to be allowed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... definition Σ1..1Reference(eHealth ActivityDefinition) {r}Protocol or definition
... requisition Σ0..1IdentifierComposite Request ID
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(eHealth Organization) {r}Organization that issued id (may be just text)
... status ?!Σ1..1codedraft | active | suspended | completed | entered-in-error | cancelled
Binding: RequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order +
Binding: RequestIntent (required)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if procedure should not be performed
... category Σ0..*CodeableConceptClassification of procedure
Binding: Procedure Category Codes (SNOMED CT) (example)
... code Σ1..1CodeableConceptWhat is being requested/ordered
Binding: ActivityDefinitionCode (required)
... subject Σ1..1Reference(eHealth Patient) {r}Individual the service is ordered for
... context Σ1..1Reference(eHealth EpisodeOfCare) {r}Encounter or Episode during which request was created
... occurrence[x] Σ0..1When procedure should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] Σ0..1Preconditions for procedure or diagnostic
Binding: SNOMED CT Medication As Needed Reason Codes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn Σ0..1dateTimeDate request signed
... requester ΣI0..1BackboneElementWho/what is requesting procedure or diagnostic
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent Σ1..1Reference(eHealth Device | eHealth Practitioner | eHealth Organization) {r}Individual making the request
.... onBehalfOf Σ0..1Reference(eHealth Organization) {r}Organization agent is acting for
... performerType Σ0..1CodeableConceptPerformer role
Binding: Participant Roles (example)
... performer Σ0..1Reference(eHealth Practitioner | eHealth Organization | eHealth Patient | eHealth Device | eHealth RelatedPerson | HealthcareService) {r}Requested perfomer
... reasonCode Σ0..*CodeableConceptExplanation/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..*CodeableConceptLocation on Body
Binding: SNOMED CT Body Structures (example)
... note 0..*AnnotationComments
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... relevantHistory 0..*Reference(eHealth Provenance) {r}Request provenance

doco Documentation for this format

 

Terminology Bindings

PathConformanceValueSet
ProcedureRequest.languageextensibleCommon Languages
Max Binding: All Languages
ProcedureRequest.requisition.userequiredIdentifierUse
ProcedureRequest.requisition.typeextensibleIdentifier Type Codes
ProcedureRequest.statusrequiredRequestStatus
ProcedureRequest.intentrequiredRequestIntent
ProcedureRequest.priorityrequiredRequestPriority
ProcedureRequest.categoryexampleProcedure Category Codes (SNOMED CT)
ProcedureRequest.coderequiredActivityDefinitionCode
ProcedureRequest.asNeeded[x]exampleSNOMED CT Medication As Needed Reason Codes
ProcedureRequest.performerTypeexampleParticipant Roles
ProcedureRequest.reasonCodeexampleProcedure Reason Codes
ProcedureRequest.bodySiteexampleSNOMED CT Body Structures

Constraints

IdPathDetailsRequirements
dom-2ProcedureRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ProcedureRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ProcedureRequestIf 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-3ProcedureRequestIf 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-1ProcedureRequest.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ProcedureRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ProcedureRequest.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ProcedureRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ProcedureRequest.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ProcedureRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ProcedureRequest.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ProcedureRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ProcedureRequest.requesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.