Profile: ehealth-procedurerequest

StructureDefinition: ehealth-procedurerequest

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 May 08 06:17:13 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

Summary

Mandatory: 2 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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

This structure is derived from ProcedureRequest

Name	Card.	Type	Description & Constraints
ProcedureRequest	0..*		A record of a request for diagnostic investigations, treatments, or operations to be performed.
extension	0..*	Extension	Slice: Unordered, Open by value:url
ehealth-referenceRange	0..*	(Complex)	Provides guide for interpretation URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
definition	1..1	Reference(eHealth ActivityDefinition) {r }
basedOn	0..0
replaces	0..0
subject	1..1	Reference(eHealth Patient) {r }
context	1..1	Reference(eHealth EpisodeOfCare) {r }
requester	0..1	BackboneElement	Who/what is requesting procedure or diagnostic
agent	1..1	Reference(eHealth Device \| eHealth Practitioner \| eHealth Organization) {r }
onBehalfOf	0..1	Reference(eHealth Organization) {r }
performer	0..1	Reference(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 }
relevantHistory	0..*	Reference(eHealth Provenance) {r }
Documentation for this format

This structure is derived from ProcedureRequest

Name	Flags	Card.	Type	Description & Constraints
ProcedureRequest	I	0..*		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)
text	I	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)	Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
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: Procedure Codes (SNOMED CT) (example)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: ActivityDefinitionCode (required)
text	Σ	0..1	string	Plain text representation of the concept
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	dateTime, Period, Timing	When procedure should occur
asNeeded[x]	Σ	0..1	boolean, CodeableConcept	Preconditions for procedure or diagnostic Binding: SNOMED CT Medication As Needed Reason Codes (example)
authoredOn	Σ	0..1	dateTime	Date request signed
requester	ΣI	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	Reference(eHealth Practitioner \| eHealth Patient \| eHealth RelatedPerson) {r }, string	Individual responsible for the annotation
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: 2 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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

Differential View

This structure is derived from ProcedureRequest

Name	Card.	Type	Description & Constraints
ProcedureRequest	0..*		A record of a request for diagnostic investigations, treatments, or operations to be performed.
extension	0..*	Extension	Slice: Unordered, Open by value:url
ehealth-referenceRange	0..*	(Complex)	Provides guide for interpretation URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
definition	1..1	Reference(eHealth ActivityDefinition) {r }
basedOn	0..0
replaces	0..0
subject	1..1	Reference(eHealth Patient) {r }
context	1..1	Reference(eHealth EpisodeOfCare) {r }
requester	0..1	BackboneElement	Who/what is requesting procedure or diagnostic
agent	1..1	Reference(eHealth Device \| eHealth Practitioner \| eHealth Organization) {r }
onBehalfOf	0..1	Reference(eHealth Organization) {r }
performer	0..1	Reference(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 }
relevantHistory	0..*	Reference(eHealth Provenance) {r }
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ProcedureRequest	I	0..*		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)
text	I	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)	Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
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: Procedure Codes (SNOMED CT) (example)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: ActivityDefinitionCode (required)
text	Σ	0..1	string	Plain text representation of the concept
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	dateTime, Period, Timing	When procedure should occur
asNeeded[x]	Σ	0..1	boolean, CodeableConcept	Preconditions for procedure or diagnostic Binding: SNOMED CT Medication As Needed Reason Codes (example)
authoredOn	Σ	0..1	dateTime	Date request signed
requester	ΣI	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	Reference(eHealth Practitioner \| eHealth Patient \| eHealth RelatedPerson) {r }, string	Individual responsible for the annotation
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	Name	Conformance	ValueSet
ProcedureRequest.language	Common Languages	extensible	Common Languages
ProcedureRequest.requisition.use	IdentifierUse	required	IdentifierUse
ProcedureRequest.requisition.type	Identifier Type Codes	extensible	Identifier Type Codes
ProcedureRequest.status	RequestStatus	required	RequestStatus
ProcedureRequest.intent	RequestIntent	required	RequestIntent
ProcedureRequest.priority	RequestPriority	required	RequestPriority
ProcedureRequest.category	Procedure Category Codes (SNOMED CT)	example	Procedure Category Codes (SNOMED CT)
ProcedureRequest.code	Procedure Codes (SNOMED CT)	example	Procedure Codes (SNOMED CT)
ProcedureRequest.code.coding	ActivityDefinitionCode	required	ActivityDefinitionCode
ProcedureRequest.asNeeded[x]	SNOMED CT Medication As Needed Reason Codes	example	SNOMED CT Medication As Needed Reason Codes
ProcedureRequest.performerType	Participant Roles	example	Participant Roles
ProcedureRequest.reasonCode	Procedure Reason Codes	example	Procedure Reason Codes
ProcedureRequest.bodySite	SNOMED CT Body Structures	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.requester	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())