Standard Health Record FHIR Implementation Guide

SHR ProcedureRequested Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-ProcedureRequested

This profile builds on ProcedureRequest.

This profile was published on Wed Dec 20 00:00:00 EST 2017 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Mandatory: 0 element (2 nested mandatory elements)
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.procedure.ProcedureRequested maps to ProcedureRequest:
  Entry.CreationTime maps to authoredOn
  RelatedEncounter maps to context
  Author maps to requester
  Type maps to code
  Category maps to category
  constrain doNotPerform to 0..0
  RequestedContext.Reason maps to reasonCode
  Subject maps to subject
  BodySite maps to bodySite
  RequestedContext.Status maps to status
  RequestedContext.RequestIntent maps to intent
  RequestedContext.ExpectedPerformanceTime maps to occurrence[x]
  RequestedContext.ExpectedPerformerType maps to performerType
  RequestedContext.ExpectedPerformer maps to performer
  RequestedContext.Priority maps to priority

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest SHR ProcedureRequested Profile
... doNotPerform 0..0
... category 0..1
... code Binding: US Core Procedure Codes (extensible)
... subject Reference(SHR Patient Profile), Reference(SHR Group Profile), Reference(SHR Geoposition Profile), Reference(SHR Device Profile)
... context Reference(SHR EncounterPerformed Profile)
... authoredOn 1..1
... bodySite Binding: SHR BodySiteVS ValueSet (required)
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
.... extension
..... value[x] Binding: RequestPriority (required)
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest I0..*SHR ProcedureRequested Profile
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... shr-core-Reason-extension 0..*(Complex)SHR Reason Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Reason-extension
.... shr-action-Status-extension 1..1code, Coding, CodeableConceptSHR Status Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension"
..... value[x] 1..1code, Coding, CodeableConceptValue of extension
Binding: RequestStatus (preferred)
.... shr-action-RequestIntent-extension 1..1codeSHR RequestIntent Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestIntent-extension
Binding: RequestIntent (required)
.... shr-action-ExpectedPerformanceTime-extension 0..1dateTime, date, Period, SHR Timing ProfileSHR ExpectedPerformanceTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformanceTime-extension
.... shr-action-ExpectedPerformerType-extension 0..1CodeableConceptSHR ExpectedPerformerType Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformerType-extension
.... shr-action-ExpectedPerformer-extension 0..1(Complex)SHR ExpectedPerformer Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformer-extension
.... shr-action-ExpectedMethod-extension 0..1(Complex)SHR ExpectedMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedMethod-extension
.... shr-core-Priority-extension 0..1positiveInt, CodeableConceptSHR Priority Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Priority-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Priority-extension"
..... value[x] 1..1positiveInt, CodeableConceptValue of extension
Binding: RequestPriority (required)
.... shr-action-PerformerInstructions-extension 0..1stringSHR PerformerInstructions Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-PerformerInstructions-extension
.... shr-action-PatientInstructions-extension 0..1stringSHR PatientInstructions Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-PatientInstructions-extension
.... shr-action-CommunicationMethod-extension 0..1CodeableConceptSHR CommunicationMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-CommunicationMethod-extension
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension"
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... definition Σ0..*Reference(ActivityDefinition), Reference(PlanDefinition)Protocol or definition
... basedOn Σ0..*Reference(Resource)What request fulfills
... replaces Σ0..*Reference(Resource)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... 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)
... category Σ0..1CodeableConceptClassification of procedure
Binding: Procedure Category Codes (SNOMED CT) (example)
... code Σ1..1CodeableConceptWhat is being requested/ordered
Binding: US Core Procedure Codes (extensible)
... subject Σ1..1Reference(SHR Patient Profile), Reference(SHR Group Profile), Reference(SHR Geoposition Profile), Reference(SHR Device Profile)Individual the service is ordered for
... context Σ0..1Reference(SHR EncounterPerformed Profile)Encounter or Episode during which request was created
... occurrence[x] Σ0..1dateTime, Period, TimingWhen procedure should occur
... asNeeded[x] Σ0..1boolean, CodeableConceptPreconditions for procedure or diagnostic
Binding: SNOMED CT Medication As Needed Reason Codes (example)
... authoredOn Σ1..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(Device), Reference(Practitioner), Reference(Organization)Individual making the request
.... onBehalfOf Σ0..1Reference(Organization)Organization agent is acting for
... performerType Σ0..1CodeableConceptPerformer role
Binding: Participant Roles (example)
... performer Σ0..1Reference(Practitioner), Reference(Organization), Reference(Patient), Reference(Device), Reference(RelatedPerson), Reference(HealthcareService)Requested perfomer
... reasonCode Σ0..*CodeableConceptExplanation/Justification for test
Binding: Procedure Reason Codes (example)
... reasonReference Σ0..*Reference(Condition), Reference(Observation)Explanation/Justification for test
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SHR BodySiteVS ValueSet (required)
... note 0..*AnnotationComments
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Summary

Mandatory: 0 element (2 nested mandatory elements)
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.procedure.ProcedureRequested maps to ProcedureRequest:
  Entry.CreationTime maps to authoredOn
  RelatedEncounter maps to context
  Author maps to requester
  Type maps to code
  Category maps to category
  constrain doNotPerform to 0..0
  RequestedContext.Reason maps to reasonCode
  Subject maps to subject
  BodySite maps to bodySite
  RequestedContext.Status maps to status
  RequestedContext.RequestIntent maps to intent
  RequestedContext.ExpectedPerformanceTime maps to occurrence[x]
  RequestedContext.ExpectedPerformerType maps to performerType
  RequestedContext.ExpectedPerformer maps to performer
  RequestedContext.Priority maps to priority

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest SHR ProcedureRequested Profile
... doNotPerform 0..0
... category 0..1
... code Binding: US Core Procedure Codes (extensible)
... subject Reference(SHR Patient Profile), Reference(SHR Group Profile), Reference(SHR Geoposition Profile), Reference(SHR Device Profile)
... context Reference(SHR EncounterPerformed Profile)
... authoredOn 1..1
... bodySite Binding: SHR BodySiteVS ValueSet (required)
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
.... extension
..... value[x] Binding: RequestPriority (required)
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest I0..*SHR ProcedureRequested Profile
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... shr-core-Reason-extension 0..*(Complex)SHR Reason Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Reason-extension
.... shr-action-Status-extension 1..1code, Coding, CodeableConceptSHR Status Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension"
..... value[x] 1..1code, Coding, CodeableConceptValue of extension
Binding: RequestStatus (preferred)
.... shr-action-RequestIntent-extension 1..1codeSHR RequestIntent Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestIntent-extension
Binding: RequestIntent (required)
.... shr-action-ExpectedPerformanceTime-extension 0..1dateTime, date, Period, SHR Timing ProfileSHR ExpectedPerformanceTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformanceTime-extension
.... shr-action-ExpectedPerformerType-extension 0..1CodeableConceptSHR ExpectedPerformerType Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformerType-extension
.... shr-action-ExpectedPerformer-extension 0..1(Complex)SHR ExpectedPerformer Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformer-extension
.... shr-action-ExpectedMethod-extension 0..1(Complex)SHR ExpectedMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedMethod-extension
.... shr-core-Priority-extension 0..1positiveInt, CodeableConceptSHR Priority Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Priority-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Priority-extension"
..... value[x] 1..1positiveInt, CodeableConceptValue of extension
Binding: RequestPriority (required)
.... shr-action-PerformerInstructions-extension 0..1stringSHR PerformerInstructions Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-PerformerInstructions-extension
.... shr-action-PatientInstructions-extension 0..1stringSHR PatientInstructions Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-PatientInstructions-extension
.... shr-action-CommunicationMethod-extension 0..1CodeableConceptSHR CommunicationMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-CommunicationMethod-extension
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension"
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... definition Σ0..*Reference(ActivityDefinition), Reference(PlanDefinition)Protocol or definition
... basedOn Σ0..*Reference(Resource)What request fulfills
... replaces Σ0..*Reference(Resource)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... 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)
... category Σ0..1CodeableConceptClassification of procedure
Binding: Procedure Category Codes (SNOMED CT) (example)
... code Σ1..1CodeableConceptWhat is being requested/ordered
Binding: US Core Procedure Codes (extensible)
... subject Σ1..1Reference(SHR Patient Profile), Reference(SHR Group Profile), Reference(SHR Geoposition Profile), Reference(SHR Device Profile)Individual the service is ordered for
... context Σ0..1Reference(SHR EncounterPerformed Profile)Encounter or Episode during which request was created
... occurrence[x] Σ0..1dateTime, Period, TimingWhen procedure should occur
... asNeeded[x] Σ0..1boolean, CodeableConceptPreconditions for procedure or diagnostic
Binding: SNOMED CT Medication As Needed Reason Codes (example)
... authoredOn Σ1..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(Device), Reference(Practitioner), Reference(Organization)Individual making the request
.... onBehalfOf Σ0..1Reference(Organization)Organization agent is acting for
... performerType Σ0..1CodeableConceptPerformer role
Binding: Participant Roles (example)
... performer Σ0..1Reference(Practitioner), Reference(Organization), Reference(Patient), Reference(Device), Reference(RelatedPerson), Reference(HealthcareService)Requested perfomer
... reasonCode Σ0..*CodeableConceptExplanation/Justification for test
Binding: Procedure Reason Codes (example)
... reasonReference Σ0..*Reference(Condition), Reference(Observation)Explanation/Justification for test
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SHR BodySiteVS ValueSet (required)
... note 0..*AnnotationComments
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
ProcedureRequest.languageCommon LanguagesextensibleCommon Languages
ProcedureRequest.extension.extension.value[x]RequestPriorityrequiredRequestPriority
ProcedureRequest.extension.extension.value[x]RequestPriorityrequiredRequestPriority
ProcedureRequest.statusRequestStatusrequiredRequestStatus
ProcedureRequest.intentRequestIntentrequiredRequestIntent
ProcedureRequest.priorityRequestPriorityrequiredRequestPriority
ProcedureRequest.categoryProcedure Category Codes (SNOMED CT)exampleProcedure Category Codes (SNOMED CT)
ProcedureRequest.codeUS Core Procedure CodesextensibleUS Core Procedure Codes
ProcedureRequest.asNeeded[x]SNOMED CT Medication As Needed Reason CodesexampleSNOMED CT Medication As Needed Reason Codes
ProcedureRequest.performerTypeParticipant RolesexampleParticipant Roles
ProcedureRequest.reasonCodeProcedure Reason CodesexampleProcedure Reason Codes
ProcedureRequest.bodySiteSHR BodySiteVS ValueSetrequiredSHR BodySiteVS ValueSet

 

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.requesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())