R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

12.14.10.2 StructureDefinition: ServiceRequest-Genetics

Orders and Observations Work Group Maturity Level: 1Trial Use Use Context: Any

The official URL for this profile is: 

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

Describes how the ServiceRequest resource is used to for genetics

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

12.14.10.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 ServiceRequest.

Summary

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*A request for a service 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: Language (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... servicerequest-geneticsItem I0..*(Complex)The items the orderer requested
URL: http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)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)
... category Σ0..*CodeableConceptClassification of service
Binding: Service Request Category Codes (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: Request priority (required)
... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code Σ0..1CodeableConceptWhat is being requested/ordered
Binding: Procedure Codes (SNOMED CT) (example)
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: Service Request Order Details Codes (example)
... quantity[x] Σ0..1Quantity, Ratio, RangeService amount
... subject Σ1..1Reference(Patient | Group | Location | Device)Individual the service is ordered for
... context Σ0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode during which request was created
... occurrence[x] Σ0..1dateTime, Period, TimingWhen service should occur
... asNeeded[x] Σ0..1boolean, CodeableConceptPreconditions for service
Binding: SNOMED CT Medication As Needed Reason Codes (example)
... authoredOn Σ0..1dateTimeDate request signed
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer role
Binding: Participant Roles (example)
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example)
... locationReference Σ0..*Reference(Location)Requested location
... reasonCode Σ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: Procedure Reason Codes (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... 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
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

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

<ServiceRequest 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>
 <instantiatesCanonical value="[canonical]"/><!-- 0..* Instantiates FHIR protocol or definition -->
 <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition -->
 <basedOn><!-- 0..* Reference(CarePlan) What request fulfills --></basedOn>
 <replaces><!-- 0..* Reference(ServiceRequest) 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 +   -->
 <category><!-- 0..* CodeableConcept Classification of service   --></category>
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat   -->
 <doNotPerform value="[boolean]"/><!-- 0..1 True if service/procedure should not be performed -->
 <code><!-- 0..1 CodeableConcept What is being requested/ordered   --></code>
 <orderDetail><!-- 0..* CodeableConcept Additional order information   --></orderDetail>
 <quantity[x]><!-- 0..1 Quantity|Ratio|Range 
     Service amount --></quantity[x]>
 <subject><!-- 1..1 Reference(Patient) 
     Individual the service is ordered for --></subject>
 <context><!-- 0..1 Reference(Encounter) 
     Encounter or Episode during which request was created --></context>
 <occurrence[x]><!-- 0..1 dateTime|Period|Timing 
     When service should occur --></occurrence[x]>
 <asNeeded[x]><!-- 0..1 boolean|CodeableConcept Preconditions for service   --></asNeeded[x]>
 <authoredOn value="[dateTime]"/><!-- 0..1 Date request signed -->
 <requester><!-- 0..1 Reference(Practitioner) 
     Who/what is requesting service --></requester>
 <performerType><!-- 0..1 CodeableConcept Performer role   --></performerType>
 <performer><!-- 0..* Reference(Practitioner) Requested performer --></performer>
 <locationCode><!-- 0..* CodeableConcept Requested location   --></locationCode>
 <locationReference><!-- 0..* Reference(Location) 
     Requested location --></locationReference>
 <reasonCode><!-- 0..* CodeableConcept Explanation/Justification for procedure or service   --></reasonCode>
 <reasonReference><!-- 0..* Reference(Condition) 
     Explanation/Justification for service or service --></reasonReference>
 <insurance><!-- 0..* Reference(Coverage) 
     Associated insurance coverage --></insurance>
 <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>
 <patientInstruction value="[string]"/><!-- 0..1 Patient or consumer-oriented instructions -->
 <relevantHistory><!-- 0..* Reference(Provenance) 
     Request provenance --></relevantHistory>
</ServiceRequest>

{ // ServiceRequest-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 order, Open 
      { // The items the orderer requested // C?
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : [{ Identifier }], //Identifiers assigned to this order
    "instantiatesCanonical" : ["<canonical>"], //Instantiates FHIR protocol or definition
    "instantiatesUri" : ["<uri>"], //Instantiates external protocol or definition
    "basedOn" : [{ Reference(CarePlan) }], //What request fulfills
    "replaces" : [{ Reference(ServiceRequest) }], //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 +
    "category" : [{ CodeableConcept }], //Classification of service
    "priority" : "<code>", //routine | urgent | asap | stat
    "doNotPerform" : <boolean>, //True if service/procedure should not be performed
    "code" : { CodeableConcept }, //What is being requested/ordered
    "orderDetail" : [{ CodeableConcept }], //Additional order information
// value[x]: Service amount. One of these 3:
    "quantityQuantity" : { Quantity }, //Service amount
    "quantityRatio" : { Ratio }, //Service amount
    "quantityRange" : { Range }, //Service amount
    "subject" : { Reference(Patient) }, // R! Individual the service is ordered for
    "context" : { Reference(Encounter) }, //Encounter or Episode during which request was created
// value[x]: When service should occur. One of these 3:
    "occurrenceDateTime" : "<dateTime>", //When service should occur
    "occurrencePeriod" : { Period }, //When service should occur
    "occurrenceTiming" : { Timing }, //When service should occur
// value[x]: Preconditions for service. One of these 2:
    "asNeededBoolean" : <boolean>, //Preconditions for service
    "asNeededCodeableConcept" : { CodeableConcept }, //Preconditions for service
    "authoredOn" : "<dateTime>", //Date request signed
    "requester" : { Reference(Practitioner) }, //Who/what is requesting service
    "performerType" : { CodeableConcept }, //Performer role
    "performer" : [{ Reference(Practitioner) }], //Requested performer
    "locationCode" : [{ CodeableConcept }], //Requested location
    "locationReference" : [{ Reference(Location) }], //Requested location
    "reasonCode" : [{ CodeableConcept }], //Explanation/Justification for procedure or service
    "reasonReference" : [{ Reference(Condition) }], //Explanation/Justification for service or service
    "insurance" : [{ Reference(Coverage) }], //Associated insurance coverage
    "supportingInfo" : [{ Reference(Resource) }], //Additional clinical information
    "specimen" : [{ Reference(Specimen) }] //Procedure Samples
    "bodySite" : [{ CodeableConcept }], //Location on Body
    "note" : [{ Annotation }], //Comments
    "patientInstruction" : "<string>", //Patient or consumer-oriented instructions
    "relevantHistory" : [{ Reference(Provenance) }], //Request provenance
  }

This structure is derived from ServiceRequest.

Summary

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*A request for a service 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: Language (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... servicerequest-geneticsItem I0..*(Complex)The items the orderer requested
URL: http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)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)
... category Σ0..*CodeableConceptClassification of service
Binding: Service Request Category Codes (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: Request priority (required)
... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code Σ0..1CodeableConceptWhat is being requested/ordered
Binding: Procedure Codes (SNOMED CT) (example)
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: Service Request Order Details Codes (example)
... quantity[x] Σ0..1Quantity, Ratio, RangeService amount
... subject Σ1..1Reference(Patient | Group | Location | Device)Individual the service is ordered for
... context Σ0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode during which request was created
... occurrence[x] Σ0..1dateTime, Period, TimingWhen service should occur
... asNeeded[x] Σ0..1boolean, CodeableConceptPreconditions for service
Binding: SNOMED CT Medication As Needed Reason Codes (example)
... authoredOn Σ0..1dateTimeDate request signed
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer role
Binding: Participant Roles (example)
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example)
... locationReference Σ0..*Reference(Location)Requested location
... reasonCode Σ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: Procedure Reason Codes (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... 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
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

XML Template

<!-- ServiceRequest-Genetics -->doco

<ServiceRequest 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>
 <instantiatesCanonical value="[canonical]"/><!-- 0..* Instantiates FHIR protocol or definition -->
 <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition -->
 <basedOn><!-- 0..* Reference(CarePlan) What request fulfills --></basedOn>
 <replaces><!-- 0..* Reference(ServiceRequest) 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 +   -->
 <category><!-- 0..* CodeableConcept Classification of service   --></category>
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat   -->
 <doNotPerform value="[boolean]"/><!-- 0..1 True if service/procedure should not be performed -->
 <code><!-- 0..1 CodeableConcept What is being requested/ordered   --></code>
 <orderDetail><!-- 0..* CodeableConcept Additional order information   --></orderDetail>
 <quantity[x]><!-- 0..1 Quantity|Ratio|Range 
     Service amount --></quantity[x]>
 <subject><!-- 1..1 Reference(Patient) 
     Individual the service is ordered for --></subject>
 <context><!-- 0..1 Reference(Encounter) 
     Encounter or Episode during which request was created --></context>
 <occurrence[x]><!-- 0..1 dateTime|Period|Timing 
     When service should occur --></occurrence[x]>
 <asNeeded[x]><!-- 0..1 boolean|CodeableConcept Preconditions for service   --></asNeeded[x]>
 <authoredOn value="[dateTime]"/><!-- 0..1 Date request signed -->
 <requester><!-- 0..1 Reference(Practitioner) 
     Who/what is requesting service --></requester>
 <performerType><!-- 0..1 CodeableConcept Performer role   --></performerType>
 <performer><!-- 0..* Reference(Practitioner) Requested performer --></performer>
 <locationCode><!-- 0..* CodeableConcept Requested location   --></locationCode>
 <locationReference><!-- 0..* Reference(Location) 
     Requested location --></locationReference>
 <reasonCode><!-- 0..* CodeableConcept Explanation/Justification for procedure or service   --></reasonCode>
 <reasonReference><!-- 0..* Reference(Condition) 
     Explanation/Justification for service or service --></reasonReference>
 <insurance><!-- 0..* Reference(Coverage) 
     Associated insurance coverage --></insurance>
 <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>
 <patientInstruction value="[string]"/><!-- 0..1 Patient or consumer-oriented instructions -->
 <relevantHistory><!-- 0..* Reference(Provenance) 
     Request provenance --></relevantHistory>
</ServiceRequest>

JSON Template

{ // ServiceRequest-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 order, Open 
      { // The items the orderer requested // C?
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : [{ Identifier }], //Identifiers assigned to this order
    "instantiatesCanonical" : ["<canonical>"], //Instantiates FHIR protocol or definition
    "instantiatesUri" : ["<uri>"], //Instantiates external protocol or definition
    "basedOn" : [{ Reference(CarePlan) }], //What request fulfills
    "replaces" : [{ Reference(ServiceRequest) }], //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 +
    "category" : [{ CodeableConcept }], //Classification of service
    "priority" : "<code>", //routine | urgent | asap | stat
    "doNotPerform" : <boolean>, //True if service/procedure should not be performed
    "code" : { CodeableConcept }, //What is being requested/ordered
    "orderDetail" : [{ CodeableConcept }], //Additional order information
// value[x]: Service amount. One of these 3:
    "quantityQuantity" : { Quantity }, //Service amount
    "quantityRatio" : { Ratio }, //Service amount
    "quantityRange" : { Range }, //Service amount
    "subject" : { Reference(Patient) }, // R! Individual the service is ordered for
    "context" : { Reference(Encounter) }, //Encounter or Episode during which request was created
// value[x]: When service should occur. One of these 3:
    "occurrenceDateTime" : "<dateTime>", //When service should occur
    "occurrencePeriod" : { Period }, //When service should occur
    "occurrenceTiming" : { Timing }, //When service should occur
// value[x]: Preconditions for service. One of these 2:
    "asNeededBoolean" : <boolean>, //Preconditions for service
    "asNeededCodeableConcept" : { CodeableConcept }, //Preconditions for service
    "authoredOn" : "<dateTime>", //Date request signed
    "requester" : { Reference(Practitioner) }, //Who/what is requesting service
    "performerType" : { CodeableConcept }, //Performer role
    "performer" : [{ Reference(Practitioner) }], //Requested performer
    "locationCode" : [{ CodeableConcept }], //Requested location
    "locationReference" : [{ Reference(Location) }], //Requested location
    "reasonCode" : [{ CodeableConcept }], //Explanation/Justification for procedure or service
    "reasonReference" : [{ Reference(Condition) }], //Explanation/Justification for service or service
    "insurance" : [{ Reference(Coverage) }], //Associated insurance coverage
    "supportingInfo" : [{ Reference(Resource) }], //Additional clinical information
    "specimen" : [{ Reference(Specimen) }] //Procedure Samples
    "bodySite" : [{ CodeableConcept }], //Location on Body
    "note" : [{ Annotation }], //Comments
    "patientInstruction" : "<string>", //Patient or consumer-oriented instructions
    "relevantHistory" : [{ Reference(Provenance) }], //Request provenance
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

12.14.10.2.2 Terminology Bindings

PathNameConformanceValueSet
ServiceRequest.languageLanguagepreferredLanguage
ServiceRequest.statusRequestStatusrequiredRequestStatus
ServiceRequest.intentRequestIntentrequiredRequestIntent
ServiceRequest.categoryService Request Category CodesexampleService Request Category Codes
ServiceRequest.priorityRequest priorityrequiredRequest priority
ServiceRequest.codeProcedure Codes (SNOMED CT)exampleProcedure Codes (SNOMED CT)
ServiceRequest.orderDetailService Request Order Details CodesexampleService Request Order Details Codes
ServiceRequest.asNeeded[x]SNOMED CT Medication As Needed Reason CodesexampleSNOMED CT Medication As Needed Reason Codes
ServiceRequest.performerTypeParticipant RolesexampleParticipant Roles
ServiceRequest.locationCodeV3 Value SetServiceDeliveryLocationRoleTypeexampleV3 Value SetServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeProcedure Reason CodesexampleProcedure Reason Codes
ServiceRequest.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
.