{
"description": "Recommendation for a particular procedure or referral to a specialist or instructions for self-care such as smoking cessation counseling or exercise",
"_filename": "StructureDefinition-cpg-servicerequest.json",
"package_name": "hl7.fhir.uv.cpg",
"date": "2019-06-06",
"derivation": "constraint",
"publisher": "Health Level Seven, Inc. - CDS WG",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "CPGServiceRequest",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://siframework.org/cqf",
"name": "Quality Improvement and Clinical Knowledge (QUICK)",
"identity": "quick"
} ],
"abstract": false,
"type": "ServiceRequest",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "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()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
}, {
"key": "prr-1",
"human": "orderDetail SHALL only be present if code is present",
"xpath": "exists(f:code) or not(exists(f:orderDetail))",
"source": "http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"severity": "error",
"expression": "orderDetail.empty() or code.exists()"
} ],
"path": "ServiceRequest",
"min": 0,
"definition": "A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.",
"isModifier": false,
"short": "A request for a service to be performed",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Request",
"identity": "workflow"
}, {
"map": "ORC",
"identity": "v2"
}, {
"map": "Act[moodCode<=INT]",
"identity": "rim"
} ],
"mustSupport": false,
"alias": [ "diagnostic request", "referral", "referral request", "transfer of care request" ],
"max": "*",
"id": "ServiceRequest",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest"
},
"isSummary": false
}, {
"path": "ServiceRequest.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"max": "1",
"id": "ServiceRequest.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "ServiceRequest.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "ServiceRequest.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "ServiceRequest.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "ServiceRequest.text",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "ServiceRequest.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "ServiceRequest.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "ServiceRequest.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "ServiceRequest.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "ServiceRequest.extension",
"min": 0,
"definition": "A clinician-friendly explanation for the recommendation; patient-friendly if the recommendation is patient-facing.",
"isModifier": false,
"short": "Explanation",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale" ]
} ],
"mustSupport": true,
"sliceName": "rationale",
"max": "1",
"id": "ServiceRequest.extension:rationale",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "ServiceRequest.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ServiceRequest.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.identifier",
"min": 0,
"definition": "Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.",
"isModifier": false,
"short": "Identifiers assigned to this order",
"mapping": [ {
"map": "Request.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "ORC.2, ORC.3, RF1-6 / RF1-11,",
"identity": "v2"
}, {
"map": ".identifier",
"identity": "rim"
}, {
"map": "ClinicalStatement.identifier",
"identity": "quick"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "ServiceRequest.identifier",
"comment": "The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below.",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.instantiatesCanonical",
"min": 0,
"definition": "A link back to the definition that produced this recommendation. Typically a Plan or Activity Definition.",
"isModifier": false,
"short": "Source",
"mapping": [ {
"map": "Request.instantiatesCanonical",
"identity": "workflow"
}, {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition" ]
} ],
"mustSupport": true,
"max": "*",
"id": "ServiceRequest.instantiatesCanonical",
"comment": "Note: This is a business identifier, not a resource identifier (see [discussion](http://hl7.org/fhir/R4/resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.instantiatesCanonical"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.instantiatesUri",
"min": 0,
"definition": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.",
"isModifier": false,
"short": "Instantiates external protocol or definition",
"mapping": [ {
"map": "Request.instantiatesUri",
"identity": "workflow"
}, {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "*",
"id": "ServiceRequest.instantiatesUri",
"comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.instantiatesUri"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.basedOn",
"min": 0,
"definition": "Plan/proposal/order fulfilled by this request.",
"isModifier": false,
"short": "What request fulfills",
"mapping": [ {
"map": "Request.basedOn",
"identity": "workflow"
}, {
"map": "ORC.8 (plus others)",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/MedicationRequest" ]
} ],
"alias": [ "fulfills" ],
"max": "*",
"id": "ServiceRequest.basedOn",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.basedOn"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.replaces",
"min": 0,
"definition": "The request takes the place of the referenced completed or terminated request(s).",
"isModifier": false,
"short": "What request replaces",
"mapping": [ {
"map": "Request.replaces",
"identity": "workflow"
}, {
"map": "Handled by message location of ORC (ORC.1=RO or RU)",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=RPLC].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ]
} ],
"alias": [ "supersedes", "prior", "renewed order" ],
"max": "*",
"id": "ServiceRequest.replaces",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.replaces"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.requisition",
"requirements": "Some business processes need to know if multiple items were ordered as part of the same \"requisition\" for billing or other purposes.",
"min": 0,
"definition": "A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.",
"isModifier": false,
"short": "Composite Request ID",
"mapping": [ {
"map": "Request.groupIdentifier",
"identity": "workflow"
}, {
"map": "ORC.4",
"identity": "v2"
}, {
"map": ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"alias": [ "grouperId", "groupIdentifier" ],
"max": "1",
"id": "ServiceRequest.requisition",
"comment": "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.requisition"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.status",
"min": 1,
"definition": "The status of the order.",
"isModifier": true,
"short": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"mapping": [ {
"map": "Request.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "ORC.5,RF1-1",
"identity": "v2"
}, {
"map": ".status",
"identity": "rim"
}, {
"map": "Action.currentStatus",
"identity": "quick"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceRequestStatus"
} ],
"description": "The status of a service order."
},
"max": "1",
"id": "ServiceRequest.status",
"comment": "The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see [Event Pattern](http://hl7.org/fhir/R4/event.html) for general discussion) or using the [Task](http://hl7.org/fhir/R4/task.html) resource.",
"base": {
"max": "1",
"min": 1,
"path": "ServiceRequest.status"
},
"isModifierReason": "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.intent",
"min": 1,
"definition": "Whether the request is a proposal, plan, an original order or a reflex order.",
"isModifier": true,
"short": "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option",
"mapping": [ {
"map": "Request.intent",
"identity": "workflow"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-intent|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceRequestIntent"
} ],
"description": "The kind of service request."
},
"max": "1",
"id": "ServiceRequest.intent",
"comment": "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.",
"base": {
"max": "1",
"min": 1,
"path": "ServiceRequest.intent"
},
"isModifierReason": "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.category",
"requirements": "Used for filtering what service request are retrieved and displayed.",
"min": 0,
"definition": "A code that classifies the service for searching, sorting and display purposes (e.g. \"Surgical Procedure\").",
"isModifier": false,
"short": "Classification of service",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "RF1-5",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"INT\"].code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/servicerequest-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceRequestCategory"
} ],
"description": "Classification of the requested service."
},
"max": "*",
"id": "ServiceRequest.category",
"comment": "There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.category"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.priority",
"min": 0,
"definition": "Indicates how quickly the ServiceRequest should be addressed with respect to other requests.",
"isModifier": false,
"short": "routine | urgent | asap | stat",
"mapping": [ {
"map": "Request.priority",
"identity": "workflow"
}, {
"map": "FiveWs.grade",
"identity": "w5"
}, {
"map": "TQ1.9, RF1-2",
"identity": "v2"
}, {
"map": ".priorityCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"meaningWhenMissing": "If missing, this task should be performed with normal priority",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceRequestPriority"
} ],
"description": "Identifies the level of importance to be assigned to actioning the request."
},
"max": "1",
"id": "ServiceRequest.priority",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.priority"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.doNotPerform",
"requirements": "Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc.",
"min": 0,
"definition": "Set this to true if the record is saying that the service/procedure should NOT be performed.",
"isModifier": true,
"short": "True if service/procedure should not be performed",
"mapping": [ {
"map": "Request.doNotPerform",
"identity": "workflow"
}, {
"map": ".actionNegationInd",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": true,
"meaningWhenMissing": "If missing, the request is a positive request e.g. \"do perform\"",
"max": "1",
"id": "ServiceRequest.doNotPerform",
"comment": "In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.doNotPerform"
},
"isModifierReason": "If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.code",
"min": 0,
"definition": "A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.",
"isModifier": false,
"short": "What is being requested/ordered",
"mapping": [ {
"map": "Request.code",
"identity": "workflow"
}, {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "PR1-3 / OBR-4 (varies by domain)",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "Procedure.procedureCode",
"identity": "quick"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/procedure-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceRequestCode"
} ],
"description": "Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available [here](valueset-diagnostic-requests.html)."
},
"alias": [ "service requested" ],
"max": "1",
"id": "ServiceRequest.code",
"comment": "Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code.",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.orderDetail",
"min": 0,
"definition": "Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.",
"isModifier": false,
"short": "Additional order information",
"mapping": [ {
"map": "NTE",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "Procedure.procedureCode",
"identity": "quick"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/servicerequest-orderdetail",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "OrderDetail"
} ],
"description": "Codified order entry details which are based on order context."
},
"alias": [ "detailed instructions" ],
"max": "*",
"id": "ServiceRequest.orderDetail",
"condition": [ "prr-1" ],
"comment": "For information from the medical record intended to support the delivery of the requested services, use the `supportingInformation` element.",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.orderDetail"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.quantity[x]",
"requirements": "When ordering a service the number of service items may need to be specified separately from the the service item.",
"min": 0,
"definition": "An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).",
"isModifier": false,
"short": "Service amount",
"mapping": [ {
"map": "NTE",
"identity": "v2"
}, {
"map": ".quantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity"
}, {
"code": "Ratio"
}, {
"code": "Range"
} ],
"max": "1",
"id": "ServiceRequest.quantity[x]",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.quantity[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.subject",
"min": 1,
"definition": "On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).",
"isModifier": false,
"short": "Individual or Entity the service is ordered for",
"mapping": [ {
"map": "Request.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "PID",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].role",
"identity": "rim"
}, {
"map": "ClinicalStatement.subject",
"identity": "quick"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-patient" ]
} ],
"mustSupport": true,
"max": "1",
"id": "ServiceRequest.subject",
"base": {
"max": "1",
"min": 1,
"path": "ServiceRequest.subject"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.encounter",
"min": 0,
"definition": "An encounter that provides additional information about the healthcare context in which this request is made.",
"isModifier": false,
"short": "Encounter in which the request was created",
"mapping": [ {
"map": "Request.encounter",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "PV1",
"identity": "v2"
}, {
"map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]",
"identity": "rim"
}, {
"map": "ClinicalStatement.encounter",
"identity": "quick"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-encounter" ]
} ],
"mustSupport": true,
"alias": [ "context" ],
"max": "1",
"id": "ServiceRequest.encounter",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.encounter"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.occurrence[x]",
"min": 0,
"definition": "The date/time at which the requested service should occur.",
"isModifier": false,
"short": "When service should occur",
"mapping": [ {
"map": "Request.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.planned",
"identity": "w5"
}, {
"map": "TQ1/TQ2, OBR-7/OBR-8",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "Procedure.procedureSchedule",
"identity": "quick"
} ],
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
}, {
"code": "Timing"
} ],
"mustSupport": true,
"alias": [ "schedule" ],
"max": "1",
"id": "ServiceRequest.occurrence[x]",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.occurrence[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.asNeeded[x]",
"min": 0,
"definition": "If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example \"pain\", \"on flare-up\", etc.",
"isModifier": false,
"short": "Preconditions for service",
"mapping": [ {
"map": "boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value",
"identity": "rim"
}, {
"map": "Proposal.prnReason.reason",
"identity": "quick"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-as-needed-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProcedureAsNeededReason"
} ],
"description": "A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example \"pain\", \"on flare-up\", etc."
},
"max": "1",
"id": "ServiceRequest.asNeeded[x]",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.asNeeded[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.authoredOn",
"min": 0,
"definition": "When the request transitioned to being actionable.",
"isModifier": false,
"short": "Date request signed",
"mapping": [ {
"map": "Request.authoredOn",
"identity": "workflow"
}, {
"map": "FiveWs.recorded",
"identity": "w5"
}, {
"map": "ORC.9, RF1-7 / RF1-9",
"identity": "v2"
}, {
"map": ".participation[typeCode=AUT].time",
"identity": "rim"
}, {
"map": "Proposal.proposedAtTime",
"identity": "quick"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "orderedOn" ],
"max": "1",
"id": "ServiceRequest.authoredOn",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.authoredOn"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.requester",
"min": 0,
"definition": "The individual who initiated the request and has responsibility for its activation.",
"isModifier": false,
"short": "Who/what is requesting service",
"mapping": [ {
"map": "Request.requester",
"identity": "workflow"
}, {
"map": "FiveWs.author",
"identity": "w5"
}, {
"map": "ORC.12, PRT",
"identity": "v2"
}, {
"map": ".participation[typeCode=AUT].role",
"identity": "rim"
}, {
"map": "ClinicalStatement.statementAuthor",
"identity": "quick"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Device" ]
} ],
"alias": [ "author", "orderer" ],
"max": "1",
"id": "ServiceRequest.requester",
"comment": "This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource.",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.requester"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.performerType",
"min": 0,
"definition": "Desired type of performer for doing the requested service.",
"isModifier": false,
"short": "Performer role",
"mapping": [ {
"map": "Request.performerType",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "PRT, RF!-3",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/participant-role",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceRequestParticipantRole"
} ],
"description": "Indicates specific responsibility of an individual within the care team, such as \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc."
},
"alias": [ "specialty" ],
"max": "1",
"id": "ServiceRequest.performerType",
"comment": "This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”.",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.performerType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.performer",
"min": 0,
"definition": "The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.",
"isModifier": false,
"short": "Requested performer",
"mapping": [ {
"map": "Request.performer",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "PRT, Practitioner: PRD-2/PRD-7 where PRD-3 = RT; Organization: PRD-10 where PRD-3 = RT",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"alias": [ "request recipient" ],
"max": "*",
"id": "ServiceRequest.performer",
"comment": "If multiple performers are present, it is interpreted as a list of *alternative* performers without any preference regardless of order. If order of preference is needed use the [request-performerOrder extension](http://hl7.org/fhir/R4/extension-request-performerorder.html). Use CareTeam to represent a group of performers (for example, Practitioner A *and* Practitioner B).",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.performer"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.locationCode",
"min": 0,
"definition": "The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.",
"isModifier": false,
"short": "Requested location",
"mapping": [ {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": ".participation[typeCode=LOC].role[scoper.determinerCode=KIND].code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceRequestLocation"
} ],
"description": "A location type where services are delivered."
},
"max": "*",
"id": "ServiceRequest.locationCode",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.locationCode"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.locationReference",
"min": 0,
"definition": "A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.",
"isModifier": false,
"short": "Requested location",
"mapping": [ {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": ".participation[typeCode=LOC].role[scoper.determinerCode=INSTANCE]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"max": "*",
"id": "ServiceRequest.locationReference",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.locationReference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.reasonCode",
"min": 0,
"definition": "An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.",
"isModifier": false,
"short": "Explanation/Justification for procedure or service",
"mapping": [ {
"map": "Request.reasonCode",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "ORC.16, RF1-10",
"identity": "v2"
}, {
"map": ".reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/procedure-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceRequestReason"
} ],
"description": "Diagnosis or problem codes justifying the reason for requesting the service investigation."
},
"max": "*",
"id": "ServiceRequest.reasonCode",
"comment": "This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use `CodeableConcept.text` element if the data is free (uncoded) text as shown in the [CT Scan example](http://hl7.org/fhir/R4/servicerequest-example-di.html).",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.reasonCode"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.reasonReference",
"min": 0,
"definition": "Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.",
"isModifier": false,
"short": "Explanation/Justification for service or service",
"mapping": [ {
"map": "Request.reasonReference",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "ORC.16",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=RSON].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"max": "*",
"id": "ServiceRequest.reasonReference",
"comment": "This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to *Observation* or *Condition* should be used if available. Otherwise when referencing *DiagnosticReport* it should contain a finding in `DiagnosticReport.conclusion` and/or `DiagnosticReport.conclusionCode`. When using a reference to *DocumentReference*, the target document should contain clear findings language providing the relevant reason for this service request. Use the CodeableConcept text element in `ServiceRequest.reasonCode` if the data is free (uncoded) text as shown in the [CT Scan example](http://hl7.org/fhir/R4/servicerequest-example-di.html).",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.reasonReference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.insurance",
"min": 0,
"definition": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.",
"isModifier": false,
"short": "Associated insurance coverage",
"mapping": [ {
"map": "Request.insurance",
"identity": "workflow"
}, {
"map": "IN1/IN2",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=COVBY].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Coverage", "http://hl7.org/fhir/StructureDefinition/ClaimResponse" ]
} ],
"max": "*",
"id": "ServiceRequest.insurance",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.insurance"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.supportingInfo",
"min": 0,
"definition": "The pertinent positive or negative information relevant to the recommendation.",
"isModifier": false,
"short": "Pertinent information",
"mapping": [ {
"map": "Request.supportingInfo",
"identity": "workflow"
}, {
"map": "Accompanying segments",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=PERT].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": true,
"alias": [ "Ask at order entry question", "AOE" ],
"max": "*",
"id": "ServiceRequest.supportingInfo",
"comment": "This will typically be the most relevant case features used in determining applicability, but could also be other patient-specific information relevant to interpreting or assessing appropriateness of the recommendation with respect to the patient.",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.supportingInfo"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.specimen",
"min": 0,
"definition": "One or more specimens that the laboratory procedure will use.",
"isModifier": false,
"short": "Procedure Samples",
"mapping": [ {
"map": "SPM",
"identity": "v2"
}, {
"map": ".participation[typeCode=SPC].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ]
} ],
"max": "*",
"id": "ServiceRequest.specimen",
"comment": "Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the [Specimen](http://hl7.org/fhir/R4/specimen.html) resource points to the ServiceRequest.",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.specimen"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.bodySite",
"requirements": "Knowing where the procedure is performed is important for tracking if multiple sites are possible.",
"min": 0,
"definition": "Anatomic location where the procedure should be performed. This is the target site.",
"isModifier": false,
"short": "Location on Body",
"mapping": [ {
"map": "SPM",
"identity": "v2"
}, {
"map": "targetSiteCode",
"identity": "rim"
}, {
"map": "Procedure.targetBodySite",
"identity": "quick"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/body-site",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BodySite"
} ],
"description": "Codes describing anatomical locations. May include laterality."
},
"alias": [ "location" ],
"max": "*",
"id": "ServiceRequest.bodySite",
"comment": "Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension [procedure-targetBodyStructure](http://hl7.org/fhir/R4/extension-procedure-targetbodystructure.html).",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.bodySite"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.note",
"min": 0,
"definition": "Any other notes and comments made about the service request. For example, internal billing notes.",
"isModifier": false,
"short": "Comments",
"mapping": [ {
"map": "Request.note",
"identity": "workflow"
}, {
"map": "NTE",
"identity": "v2"
}, {
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]",
"identity": "rim"
}, {
"map": "ClinicalStatement.additionalText",
"identity": "quick"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "ServiceRequest.note",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.note"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.patientInstruction",
"min": 0,
"definition": "Instructions in terms that are understood by the patient or consumer.",
"isModifier": false,
"short": "Patient or consumer-oriented instructions",
"mapping": [ {
"map": "NTE",
"identity": "v2"
}, {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ServiceRequest.patientInstruction",
"base": {
"max": "1",
"min": 0,
"path": "ServiceRequest.patientInstruction"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ServiceRequest.relevantHistory",
"min": 0,
"definition": "Key events in the history of the request.",
"isModifier": false,
"short": "Request provenance",
"mapping": [ {
"map": "Request.relevantHistory",
"identity": "workflow"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Provenance" ]
} ],
"max": "*",
"id": "ServiceRequest.relevantHistory",
"comment": "This might not include provenances for all versions of the request – only those deemed “relevant” or important.\rThis SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude\rAll Provenances should have some historical version of this Request as their subject.",
"base": {
"max": "*",
"min": 0,
"path": "ServiceRequest.relevantHistory"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "a7a9d4c2-2a43-4c90-9b0a-9ad47e8a5df3",
"kind": "resource",
"url": "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-servicerequest",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "ServiceRequest",
"path": "ServiceRequest",
"mustSupport": false
}, {
"id": "ServiceRequest.extension:rationale",
"max": "1",
"min": 0,
"path": "ServiceRequest.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale" ]
} ],
"sliceName": "rationale",
"mustSupport": true
}, {
"id": "ServiceRequest.identifier",
"path": "ServiceRequest.identifier",
"mustSupport": true
}, {
"id": "ServiceRequest.instantiatesCanonical",
"path": "ServiceRequest.instantiatesCanonical",
"short": "Source",
"definition": "A link back to the definition that produced this recommendation. Typically a Plan or Activity Definition.",
"mustSupport": true
}, {
"id": "ServiceRequest.status",
"path": "ServiceRequest.status",
"mustSupport": true
}, {
"id": "ServiceRequest.intent",
"path": "ServiceRequest.intent",
"mustSupport": true
}, {
"id": "ServiceRequest.category",
"path": "ServiceRequest.category",
"mustSupport": true
}, {
"id": "ServiceRequest.priority",
"path": "ServiceRequest.priority",
"mustSupport": true
}, {
"id": "ServiceRequest.doNotPerform",
"path": "ServiceRequest.doNotPerform",
"mustSupport": true
}, {
"id": "ServiceRequest.code",
"path": "ServiceRequest.code",
"mustSupport": true
}, {
"id": "ServiceRequest.subject",
"path": "ServiceRequest.subject",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-patient" ]
} ],
"mustSupport": true
}, {
"id": "ServiceRequest.encounter",
"path": "ServiceRequest.encounter",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-encounter" ]
} ],
"mustSupport": true
}, {
"id": "ServiceRequest.occurrence[x]",
"path": "ServiceRequest.occurrence[x]",
"mustSupport": true
}, {
"id": "ServiceRequest.asNeeded[x]",
"path": "ServiceRequest.asNeeded[x]",
"mustSupport": true
}, {
"id": "ServiceRequest.supportingInfo",
"path": "ServiceRequest.supportingInfo",
"short": "Pertinent information",
"comment": "This will typically be the most relevant case features used in determining applicability, but could also be other patient-specific information relevant to interpreting or assessing appropriateness of the recommendation with respect to the patient.",
"definition": "The pertinent positive or negative information relevant to the recommendation.",
"mustSupport": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/special/committees/DSS",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ServiceRequest"
}