HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.0

Publish Box goes here

ProcedureRequest

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ProcedureRequest

A request for a procedure to be performed. May be a proposal or an order.

This profile builds on ProcedureRequest.

This profile was published on Wed Apr 17 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Mandatory: 0 element (3 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.ProcedureRequest maps to ProcedureRequest:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to identifier
  StatementDateTime maps to orderedOn
  ProcedureRequester maps to orderer
  Type maps to code
  ReferralSubjectOfRecord maps to subject
  BodyLocation.LocationCode maps to bodySite
  BodyLocation.Laterality maps to bodySite.extension
  BodyLocation.Orientation maps to bodySite.extension
  BodyLocation.RelationToLandmark maps to bodySite.extension
  CareContext maps to encounter
  ReasonCode maps to reason[x]
  ReasonReference maps to reason[x]
  Status maps to status
  RequestIntent maps to extension
  ExpectedPerformanceTime maps to scheduled[x]
  ExpectedPerformerType maps to extension
  Recipient maps to performer
  PriorityCode maps to priority
  Annotation maps to notes

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest Σshr-core-ProcedureRequest
... extension 1..*Slice: Unordered, Open by value:url
... shr-core-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension
Binding: request-intent (preferred)
.... valueCodeableConcept Binding: request-intent (required)
... shr-core-ExpectedPerformerType-extension 0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformerType-extension
... shr-core-CommunicationMethod-extension 0..1CodeableConceptCommunicationMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-CommunicationMethod-extension
... shr-core-PartOf-extension 0..1Reference(shr-core-DomainResource)PartOf
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-PartOf-extension
.... valueReference Reference(shr-core-Procedure)Procedure
... shr-core-Category-extension 0..1CodeableConceptCategory
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Category-extension
... shr-core-Method-extension 0..1CodeableConceptMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Method-extension
... shr-core-Location-extension 0..1Reference(shr-core-Location)Location
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Location-extension
... shr-core-ExpectedPerformer-extension 0..1Reference(shr-core-Patient | shr-core-Practitioner | shr-core-RelatedPerson | shr-core-Organization | shr-core-Device)ExpectedPerformer
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformer-extension
... subject Reference(shr-core-Patient | shr-core-Group)
... code Binding: http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code (extensible)
... bodySite Binding: BodyLocationVS (preferred)
.... extension Slice: Unordered, Open by value:url
.... shr-core-Laterality-extension 0..*CodeableConceptLaterality
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Laterality-extension
Binding: LateralityVS (extensible)
.... shr-core-Orientation-extension 0..*CodeableConceptOrientation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Orientation-extension
Binding: OrientationVS (extensible)
.... shr-core-RelationToLandmark-extension 0..*(Complex)RelationToLandmark
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelationToLandmark-extension
... reason[x] CodeableConcept, Reference(shr-core-Condition)
... scheduled[x] dateTime, Period, Timing
... encounter Reference(shr-core-Encounter)
... performer Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient | shr-core-RelatedPerson)
... status 1..1
... notes Annotation
... orderer Reference(shr-core-Practitioner | shr-core-Device)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest Σ0..*shr-core-ProcedureRequest
... 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: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 1..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension
Binding: request-intent (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: request-intent (required)
... shr-core-ExpectedPerformerType-extension 0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformerType-extension
... shr-core-CommunicationMethod-extension 0..1CodeableConceptCommunicationMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-CommunicationMethod-extension
... shr-core-PartOf-extension 0..1Reference(shr-core-DomainResource)PartOf
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-PartOf-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-PartOf-extension"
.... valueReference 1..1Reference(shr-core-Procedure)Procedure
... shr-core-Category-extension 0..1CodeableConceptCategory
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Category-extension
... shr-core-Method-extension 0..1CodeableConceptMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Method-extension
... shr-core-Location-extension 0..1Reference(shr-core-Location)Location
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Location-extension
... shr-core-ExpectedPerformer-extension 0..1Reference(shr-core-Patient | shr-core-Practitioner | shr-core-RelatedPerson | shr-core-Organization | shr-core-Device)ExpectedPerformer
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformer-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier for the request
... subject Σ1..1Reference(shr-core-Patient | shr-core-Group)Who the procedure should be done to
... code Σ1..1CodeableConceptWhat procedure to perform
Binding: http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code (extensible)
... bodySite Σ0..*CodeableConceptWhat part of body to perform on
Binding: BodyLocationVS (preferred)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... shr-core-Laterality-extension 0..*CodeableConceptLaterality
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Laterality-extension
Binding: LateralityVS (extensible)
.... shr-core-Orientation-extension 0..*CodeableConceptOrientation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Orientation-extension
Binding: OrientationVS (extensible)
.... shr-core-RelationToLandmark-extension 0..*(Complex)RelationToLandmark
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelationToLandmark-extension
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... reason[x] Σ0..1CodeableConcept, Reference(shr-core-Condition)Why procedure should occur
Binding: Procedure Reason Codes (example)
... scheduled[x] Σ0..1dateTime, Period, TimingWhen procedure should occur
... encounter Σ0..1Reference(shr-core-Encounter)Encounter request created during
... performer Σ0..1Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient | shr-core-RelatedPerson)Who should perform the procedure
... status ?!Σ1..1codeproposed | draft | requested | received | accepted | in-progress | completed | suspended | rejected | aborted
Binding: ProcedureRequestStatus (required)
... notes Σ0..*AnnotationAdditional information about desired procedure
... asNeeded[x] Σ0..1boolean, CodeableConceptPreconditions for procedure
Binding: (unbound) (example)
... orderedOn Σ0..1dateTimeWhen request was created
... orderer Σ0..1Reference(shr-core-Practitioner | shr-core-Device)Who made request
... priority Σ0..1coderoutine | urgent | stat | asap
Binding: ProcedureRequestPriority (required)

doco Documentation for this format

Summary

Mandatory: 0 element (3 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.ProcedureRequest maps to ProcedureRequest:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to identifier
  StatementDateTime maps to orderedOn
  ProcedureRequester maps to orderer
  Type maps to code
  ReferralSubjectOfRecord maps to subject
  BodyLocation.LocationCode maps to bodySite
  BodyLocation.Laterality maps to bodySite.extension
  BodyLocation.Orientation maps to bodySite.extension
  BodyLocation.RelationToLandmark maps to bodySite.extension
  CareContext maps to encounter
  ReasonCode maps to reason[x]
  ReasonReference maps to reason[x]
  Status maps to status
  RequestIntent maps to extension
  ExpectedPerformanceTime maps to scheduled[x]
  ExpectedPerformerType maps to extension
  Recipient maps to performer
  PriorityCode maps to priority
  Annotation maps to notes

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest Σshr-core-ProcedureRequest
... extension 1..*Slice: Unordered, Open by value:url
... shr-core-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension
Binding: request-intent (preferred)
.... valueCodeableConcept Binding: request-intent (required)
... shr-core-ExpectedPerformerType-extension 0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformerType-extension
... shr-core-CommunicationMethod-extension 0..1CodeableConceptCommunicationMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-CommunicationMethod-extension
... shr-core-PartOf-extension 0..1Reference(shr-core-DomainResource)PartOf
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-PartOf-extension
.... valueReference Reference(shr-core-Procedure)Procedure
... shr-core-Category-extension 0..1CodeableConceptCategory
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Category-extension
... shr-core-Method-extension 0..1CodeableConceptMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Method-extension
... shr-core-Location-extension 0..1Reference(shr-core-Location)Location
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Location-extension
... shr-core-ExpectedPerformer-extension 0..1Reference(shr-core-Patient | shr-core-Practitioner | shr-core-RelatedPerson | shr-core-Organization | shr-core-Device)ExpectedPerformer
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformer-extension
... subject Reference(shr-core-Patient | shr-core-Group)
... code Binding: http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code (extensible)
... bodySite Binding: BodyLocationVS (preferred)
.... extension Slice: Unordered, Open by value:url
.... shr-core-Laterality-extension 0..*CodeableConceptLaterality
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Laterality-extension
Binding: LateralityVS (extensible)
.... shr-core-Orientation-extension 0..*CodeableConceptOrientation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Orientation-extension
Binding: OrientationVS (extensible)
.... shr-core-RelationToLandmark-extension 0..*(Complex)RelationToLandmark
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelationToLandmark-extension
... reason[x] CodeableConcept, Reference(shr-core-Condition)
... scheduled[x] dateTime, Period, Timing
... encounter Reference(shr-core-Encounter)
... performer Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient | shr-core-RelatedPerson)
... status 1..1
... notes Annotation
... orderer Reference(shr-core-Practitioner | shr-core-Device)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest Σ0..*shr-core-ProcedureRequest
... 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: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 1..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension
Binding: request-intent (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: request-intent (required)
... shr-core-ExpectedPerformerType-extension 0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformerType-extension
... shr-core-CommunicationMethod-extension 0..1CodeableConceptCommunicationMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-CommunicationMethod-extension
... shr-core-PartOf-extension 0..1Reference(shr-core-DomainResource)PartOf
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-PartOf-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-PartOf-extension"
.... valueReference 1..1Reference(shr-core-Procedure)Procedure
... shr-core-Category-extension 0..1CodeableConceptCategory
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Category-extension
... shr-core-Method-extension 0..1CodeableConceptMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Method-extension
... shr-core-Location-extension 0..1Reference(shr-core-Location)Location
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Location-extension
... shr-core-ExpectedPerformer-extension 0..1Reference(shr-core-Patient | shr-core-Practitioner | shr-core-RelatedPerson | shr-core-Organization | shr-core-Device)ExpectedPerformer
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformer-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier for the request
... subject Σ1..1Reference(shr-core-Patient | shr-core-Group)Who the procedure should be done to
... code Σ1..1CodeableConceptWhat procedure to perform
Binding: http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code (extensible)
... bodySite Σ0..*CodeableConceptWhat part of body to perform on
Binding: BodyLocationVS (preferred)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... shr-core-Laterality-extension 0..*CodeableConceptLaterality
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Laterality-extension
Binding: LateralityVS (extensible)
.... shr-core-Orientation-extension 0..*CodeableConceptOrientation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Orientation-extension
Binding: OrientationVS (extensible)
.... shr-core-RelationToLandmark-extension 0..*(Complex)RelationToLandmark
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelationToLandmark-extension
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... reason[x] Σ0..1CodeableConcept, Reference(shr-core-Condition)Why procedure should occur
Binding: Procedure Reason Codes (example)
... scheduled[x] Σ0..1dateTime, Period, TimingWhen procedure should occur
... encounter Σ0..1Reference(shr-core-Encounter)Encounter request created during
... performer Σ0..1Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient | shr-core-RelatedPerson)Who should perform the procedure
... status ?!Σ1..1codeproposed | draft | requested | received | accepted | in-progress | completed | suspended | rejected | aborted
Binding: ProcedureRequestStatus (required)
... notes Σ0..*AnnotationAdditional information about desired procedure
... asNeeded[x] Σ0..1boolean, CodeableConceptPreconditions for procedure
Binding: (unbound) (example)
... orderedOn Σ0..1dateTimeWhen request was created
... orderer Σ0..1Reference(shr-core-Practitioner | shr-core-Device)Who made request
... priority Σ0..1coderoutine | urgent | stat | asap
Binding: ProcedureRequestPriority (required)

doco Documentation for this format

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

 

 

Constraints

IdPathDetailsRequirements