This page is part of the Genetic Reporting Implementation Guide (v0.3.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: Request for Genetic Test

The official URL for this profile is: 

http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/servicerequest

Formal Views of Profile Content

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

This structure is derived from ServiceRequest

Summary

Mandatory: 1 element
Must-Support: 10 elements
Prohibited: 1 element

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*Request for Genetic Test
... 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: CommonLanguages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... 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 SΣ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | suspended | completed | entered-in-error | cancelled
Binding: RequestStatus (required)
... intent ?!SΣ1..1codeproposal | plan | order +
Binding: RequestIntent (required)
... category Σ0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... code SΣ0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail SΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x] Σ0..1Quantity, Ratio, RangeService amount
... subject SΣ1..1Reference(Patient | Group | Location)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] Σ0..1dateTime, Period, TimingWhen service should occur
... asNeeded[x] Σ0..1boolean, CodeableConceptPreconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (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: ParticipantRoles (example)
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference Σ0..*Reference(Location)Requested location
... reasonCode SΣ0..*CodeableConceptReason for report
Binding: ProcedureReasonCodes (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo S0..*Reference(FamilyMemberHistory | RiskAssessment | Observation | DocumentReference)Additional clinical information
... specimen SΣ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example)
... note 0..*AnnotationComments
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

This structure is derived from ServiceRequest

Summary

Mandatory: 1 element
Must-Support: 10 elements
Prohibited: 1 element

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*Request for Genetic Test
... 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: CommonLanguages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... 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 SΣ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | suspended | completed | entered-in-error | cancelled
Binding: RequestStatus (required)
... intent ?!SΣ1..1codeproposal | plan | order +
Binding: RequestIntent (required)
... category Σ0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... code SΣ0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail SΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x] Σ0..1Quantity, Ratio, RangeService amount
... subject SΣ1..1Reference(Patient | Group | Location)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] Σ0..1dateTime, Period, TimingWhen service should occur
... asNeeded[x] Σ0..1boolean, CodeableConceptPreconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (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: ParticipantRoles (example)
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference Σ0..*Reference(Location)Requested location
... reasonCode SΣ0..*CodeableConceptReason for report
Binding: ProcedureReasonCodes (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo S0..*Reference(FamilyMemberHistory | RiskAssessment | Observation | DocumentReference)Additional clinical information
... specimen SΣ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example)
... note 0..*AnnotationComments
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathNameConformanceValueSet
ServiceRequest.languageCommon LanguagespreferredCommonLanguages
ServiceRequest.statusRequestStatusrequiredRequestStatus
ServiceRequest.intentRequestIntentrequiredRequestIntent
ServiceRequest.categoryService Request Category CodesexampleServiceRequestCategoryCodes
ServiceRequest.priorityRequest priorityrequiredRequestPriority
ServiceRequest.codeProcedure Codes (SNOMED CT)exampleProcedureCodes(SNOMEDCT)
ServiceRequest.orderDetailService Request Order Details CodesexampleServiceRequestOrderDetailsCodes
ServiceRequest.asNeeded[x]SNOMED CT Medication As Needed Reason CodesexampleSNOMEDCTMedicationAsNeededReasonCodes
ServiceRequest.performerTypeParticipant RolesexampleParticipantRoles
ServiceRequest.locationCodeV3 Value SetServiceDeliveryLocationRoleTypeexamplev3.ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeProcedure Reason CodesexampleProcedureReasonCodes
ServiceRequest.bodySiteSNOMED CT Body StructuresexampleSNOMEDCTBodyStructures

Constraints

IdPathDetailsRequirements
dom-2ServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4ServiceRequestIf 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-3ServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6ServiceRequestA resource should have narrative for robust management
: text.div.exists()
dom-5ServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
prr-1ServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()