0.3.0 - Second STU ballot

This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: ServiceRequestR4

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest-r4

Formal Views of Profile Content

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

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: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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 SΣ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical SΣ1..1canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn SΣ1..1Reference(ServiceRequestR4 | MedicationRequestR4)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | suspended | completed | entered-in-error | cancelled
Binding: RequestStatus (required)
Fixed Value: draft
... intent ?!Σ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Σ1..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x] Σ0..1Quantity, Ratio, RangeService amount
... subject SΣ1..1Reference(PatientR4)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(EncounterR4)Encounter in which the request was created
... occurrence[x] SΣ0..1dateTime, Period, TimingWhen service should occur
... asNeeded[x] Σ0..1boolean, CodeableConceptPreconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
... authoredOn SΣ1..1dateTimeDate request signed
... requester SΣ1..1Reference(PractitionerR4 | US Core PractitionerRole Profile)Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example)
... performer SΣ0..*Reference(PractitionerR4 | US Core PractitionerRole Profile)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference SΣ1..1Reference(LocationR4)Requested location
... reasonCode SΣ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example)
... reasonReference SΣ0..*Reference(US Core Condition Profile | US Core Result Observation Profile)Explanation/Justification for service or service
... insurance S0..*Reference(CoverageR4)Associated insurance coverage
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ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

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: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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 SΣ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical SΣ1..1canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn SΣ1..1Reference(ServiceRequestR4 | MedicationRequestR4)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | suspended | completed | entered-in-error | cancelled
Binding: RequestStatus (required)
Fixed Value: draft
... intent ?!Σ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Σ1..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x] Σ0..1Quantity, Ratio, RangeService amount
... subject SΣ1..1Reference(PatientR4)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(EncounterR4)Encounter in which the request was created
... occurrence[x] SΣ0..1dateTime, Period, TimingWhen service should occur
... asNeeded[x] Σ0..1boolean, CodeableConceptPreconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
... authoredOn SΣ1..1dateTimeDate request signed
... requester SΣ1..1Reference(PractitionerR4 | US Core PractitionerRole Profile)Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example)
... performer SΣ0..*Reference(PractitionerR4 | US Core PractitionerRole Profile)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference SΣ1..1Reference(LocationR4)Requested location
... reasonCode SΣ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example)
... reasonReference SΣ0..*Reference(US Core Condition Profile | US Core Result Observation Profile)Explanation/Justification for service or service
... insurance S0..*Reference(CoverageR4)Associated insurance coverage
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ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

PathConformanceValueSet / Code
ServiceRequest.statusrequiredFixed Value: draft
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
ServiceRequest.reasonCodeexampleProcedureReasonCodes

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()