Genomics Reporting Implementation Guide (STU1)

This page is part of the Genetic Reporting Implementation Guide (v1.0.0: STU 1) 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: ServiceRequest

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
Prohibited: 1 element

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*ServiceRequest
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical ΣI0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces ΣI0..*Reference(ServiceRequest)What request replaces
... requisition ΣI0..1IdentifierComposite Request ID
... status ?!ΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!ΣI1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
... category ΣI0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... code ΣI0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x] ΣI0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject ΣI1..1Reference(Patient | Group | Location)Individual or Entity the service is ordered for
... encounter ΣI0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] ΣI0..1When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] ΣI0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn ΣI0..1dateTimeDate request signed
... requester ΣI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... performerType ΣI0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example)
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode ΣI0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference ΣI0..*Reference(Location)Requested location
... reasonCode ΣI0..*CodeableConceptReason for report
Binding: ProcedureReasonCodes (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance I0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo I0..*Reference(FamilyMemberHistory | RiskAssessment | Observation | DocumentReference)Additional clinical information
... specimen ΣI0..*Reference(Specimen)Procedure Samples
... bodySite ΣI0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example)
... note I0..*AnnotationComments
... patientInstruction ΣI0..1stringPatient or consumer-oriented instructions
... relevantHistory I0..*Reference(Provenance)Request provenance

doco Documentation for this format

This structure is derived from ServiceRequest

Summary

Mandatory: 1 element
Prohibited: 1 element

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*ServiceRequest
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical ΣI0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces ΣI0..*Reference(ServiceRequest)What request replaces
... requisition ΣI0..1IdentifierComposite Request ID
... status ?!ΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!ΣI1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
... category ΣI0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... code ΣI0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x] ΣI0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject ΣI1..1Reference(Patient | Group | Location)Individual or Entity the service is ordered for
... encounter ΣI0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] ΣI0..1When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] ΣI0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn ΣI0..1dateTimeDate request signed
... requester ΣI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... performerType ΣI0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example)
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode ΣI0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference ΣI0..*Reference(Location)Requested location
... reasonCode ΣI0..*CodeableConceptReason for report
Binding: ProcedureReasonCodes (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance I0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo I0..*Reference(FamilyMemberHistory | RiskAssessment | Observation | DocumentReference)Additional clinical information
... specimen ΣI0..*Reference(Specimen)Procedure Samples
... bodySite ΣI0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example)
... note I0..*AnnotationComments
... patientInstruction ΣI0..1stringPatient or consumer-oriented instructions
... relevantHistory I0..*Reference(Provenance)Request provenance

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
ServiceRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredRequestIntent
ServiceRequest.categoryexampleServiceRequestCategoryCodes
ServiceRequest.priorityrequiredRequestPriority
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ServiceRequest.performerTypeexampleParticipantRoles
ServiceRequest.locationCodeexamplev3.ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeexampleProcedureReasonCodes
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdPathDetailsRequirements
dom-2ServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.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-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-5ServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
prr-1ServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
ele-1ServiceRequest.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ServiceRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ServiceRequest.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ServiceRequest.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ServiceRequest.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.instantiatesUriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.replacesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.requisitionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.intentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.orderDetailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.quantity[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.occurrence[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.asNeeded[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.authoredOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.requesterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.performerTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.locationCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.locationReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.insuranceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.supportingInfoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.specimenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.patientInstructionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.relevantHistoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())