FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

12.15.11.2 StructureDefinition: ProcedureRequest-Genetics

(No assigned work group) Maturity Level: 1InformativeUse Context: Any

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/procedurerequest-genetics

Describes how the ProcedureRequest resource is used to for genetics

This profile was published on Tue, Oct 20, 2015 00:00+1100 as a draft by Health Level Seven International (Clinical Genomics).

12.15.11.2.1 Formal Views of Profile Content

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

This structure is derived from ProcedureRequest.

Summary

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest I0..*A request for a procedure or diagnostic 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... procedurerequest-geneticsItem I0..*(Complex)The items the orderer requested
URL: http://hl7.org/fhir/StructureDefinition/procedurerequest-geneticsItem
... 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)
... 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: Procedure Codes (SNOMED CT) (example)
... subject Σ1..1Reference(Patient), Reference(Group), Reference(Location), Reference(Device)Individual the service is ordered for
... context Σ0..1Reference(Encounter), Reference(EpisodeOfCare)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 Σ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(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: SNOMED CT Body Structures (example)
... note 0..*AnnotationComments
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format
<!-- ProcedureRequest-Genetics -->doco

<ProcedureRequest xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- 0..1 Language of the resource content  -->
 <text><!-- 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* Identifier 
     Identifiers assigned to this order --></identifier>
 <definition><!-- 0..* Reference(ActivityDefinition)|Reference(PlanDefinition) 
     Protocol or definition --></definition>
 <basedOn><!-- 0..* Reference(Resource) What request fulfills --></basedOn>
 <replaces><!-- 0..* Reference(Resource) What request replaces --></replaces>
 <requisition><!-- 0..1 Identifier 
     Composite Request ID --></requisition>
 <status value="[code]"/><!-- 1..1 draft | active | suspended | completed | entered-in-error | cancelled  -->
 <intent value="[code]"/><!-- 1..1 proposal | plan | order +  -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat  -->
 <doNotPerform value="[boolean]"/><!-- 0..1 True if procedure should not be performed -->
 <category><!-- 0..* CodeableConcept Classification of procedure  --></category>
 <code><!-- 1..1 CodeableConcept What is being requested/ordered  --></code>
 <subject><!-- 1..1 Reference(Patient)|Reference(Group)|Reference(Location)|Reference(Device) 
     Individual the service is ordered for --></subject>
 <context><!-- 0..1 Reference(Encounter)|Reference(EpisodeOfCare) 
     Encounter or Episode during which request was created --></context>
 <occurrence[x]><!-- 0..1 dateTime|Period|Timing 
     When procedure should occur --></occurrence[x]>
 <asNeeded[x]><!-- 0..1 boolean|CodeableConcept Preconditions for procedure or diagnostic  --></asNeeded[x]>
 <authoredOn value="[dateTime]"/><!-- 0..1 Date request signed -->
 <requester> ?? 0..1 BackboneElement  <!-- ?? 0..1 Who/what is requesting procedure or diagnostic -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <agent><!-- 1..1 Reference(Device)|Reference(Practitioner)|Reference(Organization) 
      Individual making the request --></agent>
  <onBehalfOf><!-- 0..1 Reference(Organization) 
      Organization agent is acting for --></onBehalfOf>
 </requester>
 <performerType><!-- 0..1 CodeableConcept Performer role  --></performerType>
 <performer><!-- 0..1 Reference(Practitioner)|Reference(Organization)|Reference(Patient)|Reference(Device)|
   Reference(RelatedPerson)|Reference(HealthcareService) Requested perfomer --></performer>
 <reasonCode><!-- 0..* CodeableConcept Explanation/Justification for test  --></reasonCode>
 <reasonReference><!-- 0..* Reference(Condition)|Reference(Observation) 
     Explanation/Justification for test --></reasonReference>
 <supportingInfo><!-- 0..* Reference(Resource) 
     Additional clinical information --></supportingInfo>
 <specimen><!-- 0..* Reference(Specimen) Procedure Samples --></specimen>
 <bodySite><!-- 0..* CodeableConcept Location on Body  --></bodySite>
 <note><!-- 0..* Annotation Comments --></note>
 <relevantHistory><!-- 0..* Reference(Provenance) 
     Request provenance --></relevantHistory>
</ProcedureRequest>

{ // ProcedureRequest-Genetics
  // from Element: extension
    "meta" : { Meta }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content 
    "text" : { Narrative }, //Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // The items the orderer requested // C?
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : [{ Identifier }], //Identifiers assigned to this order
// value[x]: Protocol or definition. One of these 2:
    "definition" : [{ Reference(ActivityDefinition) }], //Protocol or definition
    "definition" : [{ Reference(PlanDefinition) }], //Protocol or definition
    "basedOn" : [{ Reference(Resource) }], //What request fulfills
    "replaces" : [{ Reference(Resource) }], //What request replaces
    "requisition" : { Identifier }, //Composite Request ID
    "status" : "<code>", // R! draft | active | suspended | completed | entered-in-error | cancelled 
    "intent" : "<code>", // R! proposal | plan | order + 
    "priority" : "<code>", //routine | urgent | asap | stat 
    "doNotPerform" : <boolean>, //True if procedure should not be performed
    "category" : [{ CodeableConcept }], //Classification of procedure 
    "code" : { CodeableConcept }, // R! What is being requested/ordered 
// value[x]: Individual the service is ordered for. One of these 4:
    "subject" : { Reference(Patient) }, // R! Individual the service is ordered for
    "subject" : { Reference(Group) }, // R! Individual the service is ordered for
    "subject" : { Reference(Location) }, // R! Individual the service is ordered for
    "subject" : { Reference(Device) }, // R! Individual the service is ordered for
// value[x]: Encounter or Episode during which request was created. One of these 2:
    "context" : { Reference(Encounter) }, //Encounter or Episode during which request was created
    "context" : { Reference(EpisodeOfCare) }, //Encounter or Episode during which request was created
// value[x]: When procedure should occur. One of these 3:
    "occurrenceDateTime" : "<dateTime>", //When procedure should occur
    "occurrencePeriod" : { Period }, //When procedure should occur
    "occurrenceTiming" : { Timing }, //When procedure should occur
// value[x]: Preconditions for procedure or diagnostic. One of these 2:
    "asNeededBoolean" : <boolean>, //Preconditions for procedure or diagnostic 
    "asNeededCodeableConcept" : { CodeableConcept }, //Preconditions for procedure or diagnostic 
    "authoredOn" : "<dateTime>", //Date request signed
    "requester" : { BackboneElement }, // C?Who/what is requesting procedure or diagnostic
    "performerType" : { CodeableConcept }, //Performer role 
// value[x]: Requested perfomer. One of these 6:
    "performer" : { Reference(Practitioner) } //Requested perfomer
    "performer" : { Reference(Organization) }, //Requested perfomer
    "performer" : { Reference(Patient) }, //Requested perfomer
    "performer" : { Reference(Device) }, //Requested perfomer
    "performer" : { Reference(RelatedPerson) }, //Requested perfomer
    "performer" : { Reference(HealthcareService) }, //Requested perfomer
    "reasonCode" : [{ CodeableConcept }], //Explanation/Justification for test 
// value[x]: Explanation/Justification for test. One of these 2:
    "reasonReference" : [{ Reference(Condition) }], //Explanation/Justification for test
    "reasonReference" : [{ Reference(Observation) }], //Explanation/Justification for test
    "supportingInfo" : [{ Reference(Resource) }], //Additional clinical information
    "specimen" : [{ Reference(Specimen) }], //Procedure Samples
    "bodySite" : [{ CodeableConcept }], //Location on Body 
    "note" : [{ Annotation }], //Comments
    "relevantHistory" : [{ Reference(Provenance) }], //Request provenance
  }

This structure is derived from ProcedureRequest.

Summary

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureRequest I0..*A request for a procedure or diagnostic 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... procedurerequest-geneticsItem I0..*(Complex)The items the orderer requested
URL: http://hl7.org/fhir/StructureDefinition/procedurerequest-geneticsItem
... 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)
... 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: Procedure Codes (SNOMED CT) (example)
... subject Σ1..1Reference(Patient), Reference(Group), Reference(Location), Reference(Device)Individual the service is ordered for
... context Σ0..1Reference(Encounter), Reference(EpisodeOfCare)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 Σ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(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: SNOMED CT Body Structures (example)
... note 0..*AnnotationComments
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

XML Template

<!-- ProcedureRequest-Genetics -->doco

<ProcedureRequest xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- 0..1 Language of the resource content  -->
 <text><!-- 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* Identifier 
     Identifiers assigned to this order --></identifier>
 <definition><!-- 0..* Reference(ActivityDefinition)|Reference(PlanDefinition) 
     Protocol or definition --></definition>
 <basedOn><!-- 0..* Reference(Resource) What request fulfills --></basedOn>
 <replaces><!-- 0..* Reference(Resource) What request replaces --></replaces>
 <requisition><!-- 0..1 Identifier 
     Composite Request ID --></requisition>
 <status value="[code]"/><!-- 1..1 draft | active | suspended | completed | entered-in-error | cancelled  -->
 <intent value="[code]"/><!-- 1..1 proposal | plan | order +  -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat  -->
 <doNotPerform value="[boolean]"/><!-- 0..1 True if procedure should not be performed -->
 <category><!-- 0..* CodeableConcept Classification of procedure  --></category>
 <code><!-- 1..1 CodeableConcept What is being requested/ordered  --></code>
 <subject><!-- 1..1 Reference(Patient)|Reference(Group)|Reference(Location)|Reference(Device) 
     Individual the service is ordered for --></subject>
 <context><!-- 0..1 Reference(Encounter)|Reference(EpisodeOfCare) 
     Encounter or Episode during which request was created --></context>
 <occurrence[x]><!-- 0..1 dateTime|Period|Timing 
     When procedure should occur --></occurrence[x]>
 <asNeeded[x]><!-- 0..1 boolean|CodeableConcept Preconditions for procedure or diagnostic  --></asNeeded[x]>
 <authoredOn value="[dateTime]"/><!-- 0..1 Date request signed -->
 <requester> ?? 0..1 BackboneElement  <!-- ?? 0..1 Who/what is requesting procedure or diagnostic -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <agent><!-- 1..1 Reference(Device)|Reference(Practitioner)|Reference(Organization) 
      Individual making the request --></agent>
  <onBehalfOf><!-- 0..1 Reference(Organization) 
      Organization agent is acting for --></onBehalfOf>
 </requester>
 <performerType><!-- 0..1 CodeableConcept Performer role  --></performerType>
 <performer><!-- 0..1 Reference(Practitioner)|Reference(Organization)|Reference(Patient)|Reference(Device)|
   Reference(RelatedPerson)|Reference(HealthcareService) Requested perfomer --></performer>
 <reasonCode><!-- 0..* CodeableConcept Explanation/Justification for test  --></reasonCode>
 <reasonReference><!-- 0..* Reference(Condition)|Reference(Observation) 
     Explanation/Justification for test --></reasonReference>
 <supportingInfo><!-- 0..* Reference(Resource) 
     Additional clinical information --></supportingInfo>
 <specimen><!-- 0..* Reference(Specimen) Procedure Samples --></specimen>
 <bodySite><!-- 0..* CodeableConcept Location on Body  --></bodySite>
 <note><!-- 0..* Annotation Comments --></note>
 <relevantHistory><!-- 0..* Reference(Provenance) 
     Request provenance --></relevantHistory>
</ProcedureRequest>

JSON Template

{ // ProcedureRequest-Genetics
  // from Element: extension
    "meta" : { Meta }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content 
    "text" : { Narrative }, //Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // The items the orderer requested // C?
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : [{ Identifier }], //Identifiers assigned to this order
// value[x]: Protocol or definition. One of these 2:
    "definition" : [{ Reference(ActivityDefinition) }], //Protocol or definition
    "definition" : [{ Reference(PlanDefinition) }], //Protocol or definition
    "basedOn" : [{ Reference(Resource) }], //What request fulfills
    "replaces" : [{ Reference(Resource) }], //What request replaces
    "requisition" : { Identifier }, //Composite Request ID
    "status" : "<code>", // R! draft | active | suspended | completed | entered-in-error | cancelled 
    "intent" : "<code>", // R! proposal | plan | order + 
    "priority" : "<code>", //routine | urgent | asap | stat 
    "doNotPerform" : <boolean>, //True if procedure should not be performed
    "category" : [{ CodeableConcept }], //Classification of procedure 
    "code" : { CodeableConcept }, // R! What is being requested/ordered 
// value[x]: Individual the service is ordered for. One of these 4:
    "subject" : { Reference(Patient) }, // R! Individual the service is ordered for
    "subject" : { Reference(Group) }, // R! Individual the service is ordered for
    "subject" : { Reference(Location) }, // R! Individual the service is ordered for
    "subject" : { Reference(Device) }, // R! Individual the service is ordered for
// value[x]: Encounter or Episode during which request was created. One of these 2:
    "context" : { Reference(Encounter) }, //Encounter or Episode during which request was created
    "context" : { Reference(EpisodeOfCare) }, //Encounter or Episode during which request was created
// value[x]: When procedure should occur. One of these 3:
    "occurrenceDateTime" : "<dateTime>", //When procedure should occur
    "occurrencePeriod" : { Period }, //When procedure should occur
    "occurrenceTiming" : { Timing }, //When procedure should occur
// value[x]: Preconditions for procedure or diagnostic. One of these 2:
    "asNeededBoolean" : <boolean>, //Preconditions for procedure or diagnostic 
    "asNeededCodeableConcept" : { CodeableConcept }, //Preconditions for procedure or diagnostic 
    "authoredOn" : "<dateTime>", //Date request signed
    "requester" : { BackboneElement }, // C?Who/what is requesting procedure or diagnostic
    "performerType" : { CodeableConcept }, //Performer role 
// value[x]: Requested perfomer. One of these 6:
    "performer" : { Reference(Practitioner) } //Requested perfomer
    "performer" : { Reference(Organization) }, //Requested perfomer
    "performer" : { Reference(Patient) }, //Requested perfomer
    "performer" : { Reference(Device) }, //Requested perfomer
    "performer" : { Reference(RelatedPerson) }, //Requested perfomer
    "performer" : { Reference(HealthcareService) }, //Requested perfomer
    "reasonCode" : [{ CodeableConcept }], //Explanation/Justification for test 
// value[x]: Explanation/Justification for test. One of these 2:
    "reasonReference" : [{ Reference(Condition) }], //Explanation/Justification for test
    "reasonReference" : [{ Reference(Observation) }], //Explanation/Justification for test
    "supportingInfo" : [{ Reference(Resource) }], //Additional clinical information
    "specimen" : [{ Reference(Specimen) }], //Procedure Samples
    "bodySite" : [{ CodeableConcept }], //Location on Body 
    "note" : [{ Annotation }], //Comments
    "relevantHistory" : [{ Reference(Provenance) }], //Request provenance
  }

 

Other representations of profile: Schematron

12.15.11.2.2 Terminology Bindings

PathNameConformanceValueSet
ProcedureRequest.languageCommon LanguagesextensibleCommon Languages
ProcedureRequest.statusRequestStatusrequiredRequestStatus
ProcedureRequest.intentRequestIntentrequiredRequestIntent
ProcedureRequest.priorityRequestPriorityrequiredRequestPriority
ProcedureRequest.categoryProcedure Category Codes (SNOMED CT)exampleProcedure Category Codes (SNOMED CT)
ProcedureRequest.codeProcedure Codes (SNOMED CT)exampleProcedure Codes (SNOMED CT)
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.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
.