# Create FHIR r4 service request
Endpoint: POST /site/{siteId}/fhir/service-request
Version: 1.0
Security: bearer, bearer
## Path parameters:
- `siteId` (string, required)
Site identifier
## Request fields (application/json):
- `resourceType` (any, required)
This is a ServiceRequest resource
Enum: "ServiceRequest"
- `id` (string)
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
- `meta` (object)
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- `meta.id` (string)
An extension object type #string.
Example: "example-string"
- `meta.extension` (array)
May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- `meta.versionId` (object)
An extension object type #id.
- `meta._versionId` (object)
An extension object type #Element.
- `meta.lastUpdated` (object)
An extension object type #instant.
- `meta._lastUpdated` (object)
An extension object type #Element.
- `meta.source` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `meta._source` (object)
An extension object type #Element.
- `meta.profile` (array)
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
Example: ["http://example.org/Profile"]
- `meta.security` (array)
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
- `meta.tag` (array)
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
- `implicitRules` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_implicitRules` (object)
Base definition for all elements in a resource.
- `language` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_language` (object)
Base definition for all elements in a resource.
- `text` (object)
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
- `text.status` (any)
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Enum: "generated", "extensions", "additional", "empty"
- `text._status` (object)
An extension object type #Element.
- `text.div` (string, required)
An extension object type #xhtml.
Example: "
Example
"
- `contained` (array)
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.
- `extension` (array)
May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- `extension.url` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `extension._url` (object)
An extension object type #Element.
- `extension.valueBase64Binary` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "U2FtcGxl"
- `extension._valueBase64Binary` (object)
An extension object type #Element.
- `extension.valueBoolean` (boolean)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: true
- `extension._valueBoolean` (object)
An extension object type #Element.
- `extension.valueCanonical` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "http://example.org/Profile"
- `extension._valueCanonical` (object)
An extension object type #Element.
- `extension.valueCode` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "sample-code"
- `extension._valueCode` (object)
An extension object type #Element.
- `extension.valueDate` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01"
- `extension._valueDate` (object)
An extension object type #Element.
- `extension.valueDateTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueDateTime` (object)
An extension object type #Element.
- `extension.valueDecimal` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1.23
- `extension._valueDecimal` (object)
An extension object type #Element.
- `extension.valueId` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-id"
- `extension._valueId` (object)
An extension object type #Element.
- `extension.valueInstant` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueInstant` (object)
An extension object type #Element.
- `extension.valueInteger` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valueInteger` (object)
An extension object type #Element.
- `extension.valueMarkdown` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "Sample markdown text"
- `extension._valueMarkdown` (object)
An extension object type #Element.
- `extension.valueOid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:oid:1.2.3.4.5"
- `extension._valueOid` (object)
An extension object type #Element.
- `extension.valuePositiveInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valuePositiveInt` (object)
An extension object type #Element.
- `extension.valueString` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-string"
- `extension._valueString` (object)
An extension object type #Element.
- `extension.valueTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "12:00:00"
- `extension._valueTime` (object)
An extension object type #Element.
- `extension.valueUnsignedInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
- `extension._valueUnsignedInt` (object)
An extension object type #Element.
- `extension.valueUri` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org/resource"
- `extension._valueUri` (object)
An extension object type #Element.
- `extension.valueUrl` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org"
- `extension._valueUrl` (object)
An extension object type #Element.
- `extension.valueUuid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
- `extension._valueUuid` (object)
An extension object type #Element.
- `extension.valueAddress` (object)
An extension object type #Address.
- `extension.valueAge` (object)
An extension object type #Age.
- `extension.valueAnnotation` (object)
An extension object type #Annotation.
- `extension.valueAttachment` (object)
An extension object type #Attachment.
- `extension.valueCodeableConcept` (object)
An extension object type #CodeableConcept.
- `extension.valueCoding` (object)
An extension object type #Coding.
- `extension.valueContactPoint` (object)
An extension object type #ContactPoint.
- `extension.valueCount` (object)
An extension object type #Count.
- `extension.valueDistance` (object)
An extension object type #Distance.
- `extension.valueDuration` (object)
An extension object type #Duration.
- `extension.valueHumanName` (object)
An extension object type #HumanName.
- `extension.valueIdentifier` (object)
An extension object type #Identifier.
- `extension.valueMoney` (object)
An extension object type #Money.
- `extension.valuePeriod` (object)
An extension object type #Period.
- `extension.valueQuantity` (object)
An extension object type #Quantity.
- `extension.valueRange` (object)
An extension object type #Range.
- `extension.valueRatio` (object)
An extension object type #Ratio.
- `extension.valueReference` (object)
An extension object type #Reference.
- `extension.valueSampledData` (object)
An extension object type #SampledData.
- `extension.valueSignature` (object)
An extension object type #Signature.
- `extension.valueTiming` (object)
An extension object type #Timing.
- `extension.valueContactDetail` (object)
An extension object type #ContactDetail.
- `extension.valueContributor` (object)
An extension object type #Contributor.
- `extension.valueDataRequirement` (object)
An extension object type #DataRequirement.
- `extension.valueExpression` (object)
An extension object type #Expression.
- `extension.valueParameterDefinition` (object)
An extension object type #ParameterDefinition.
- `extension.valueRelatedArtifact` (object)
An extension object type #RelatedArtifact.
- `extension.valueTriggerDefinition` (object)
An extension object type #TriggerDefinition.
- `extension.valueUsageContext` (object)
An extension object type #UsageContext.
- `extension.valueDosage` (object)
An extension object type #Dosage.
- `extension.valueMeta` (object)
An extension object type #Meta.
- `modifierExtension` (array)
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.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- `identifier` (array)
Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
- `identifier.use` (any)
The purpose of this identifier.
Enum: "usual", "official", "temp", "secondary", "old"
- `identifier._use` (object)
An extension object type #Element.
- `identifier.type` (object)
An extension object type #CodeableConcept.
- `identifier.system` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `identifier._system` (object)
An extension object type #Element.
- `identifier.value` (string)
An extension object type #string.
Example: "example-string"
- `identifier._value` (object)
An extension object type #Element.
- `identifier.period` (object)
An extension object type #Period.
- `identifier.assigner` (object)
An extension object type #Reference.
- `instantiatesCanonical` (array)
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
Example: ["http://example.org/Profile"]
- `instantiatesUri` (array)
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.
Example: ["https://example.org/resource"]
- `_instantiatesUri` (array)
Extensions for instantiatesUri
- `basedOn` (array)
Plan/proposal/order fulfilled by this request.
- `basedOn.reference` (string)
An extension object type #string.
Example: "example-string"
- `basedOn._reference` (object)
An extension object type #Element.
- `basedOn.type` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `basedOn._type` (object)
An extension object type #Element.
- `basedOn.identifier` (object)
An extension object type #Identifier.
- `basedOn.display` (string)
An extension object type #string.
Example: "example-string"
- `basedOn._display` (object)
An extension object type #Element.
- `replaces` (array)
The request takes the place of the referenced completed or terminated request(s).
- `requisition` (object)
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
- `status` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_status` (object)
Base definition for all elements in a resource.
- `intent` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_intent` (object)
Base definition for all elements in a resource.
- `category` (array)
A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
Example: [{"coding":[{"system":"http://snomed.info/sct","code":"103693007","display":"Diagnostic procedure (procedure)"}],"text":"Diagnostics Procedure"}]
- `category.coding` (array)
A reference to a code defined by a terminology system.
- `category.text` (string)
An extension object type #string.
Example: "example-string"
- `category._text` (object)
An extension object type #Element.
- `priority` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_priority` (object)
Base definition for all elements in a resource.
- `doNotPerform` (boolean)
Value of "true" or "false"
Example: true
- `_doNotPerform` (object)
Base definition for all elements in a resource.
- `code` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `orderDetail` (array)
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.
- `quantityQuantity` (object)
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
- `quantityQuantity.value` (number)
An extension object type #decimal.
Example: 1.23
- `quantityQuantity.comparator` (any)
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Enum: "<", "<=", ">=", ">"
- `quantityQuantity._comparator` (object)
An extension object type #Element.
- `quantityQuantity.unit` (string)
An extension object type #string.
Example: "example-string"
- `quantityQuantity._unit` (object)
An extension object type #Element.
- `quantityQuantity.code` (string)
An extension object type #code.
Example: "sample-code"
- `quantityQuantity._code` (object)
An extension object type #Element.
- `quantityRatio` (object)
A relationship of two Quantity values - expressed as a numerator and a denominator.
- `quantityRatio.numerator` (object)
An extension object type #Quantity.
- `quantityRatio.denominator` (object)
An extension object type #Quantity.
- `quantityRange` (object)
A set of ordered Quantities defined by a low and high limit.
- `quantityRange.low` (object)
An extension object type #Quantity.
- `quantityRange.high` (object)
An extension object type #Quantity.
- `subject` (object, required)
A reference from one resource to another.
- `encounter` (object)
A reference from one resource to another.
- `occurrenceDateTime` (string)
The date/time at which the requested service should occur.
Example: "example-string"
- `_occurrenceDateTime` (object)
Base definition for all elements in a resource.
- `occurrencePeriod` (object)
A time period defined by a start and end date and optionally time.
- `occurrencePeriod.start` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `occurrencePeriod._start` (object)
An extension object type #Element.
- `occurrencePeriod.end` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `occurrencePeriod._end` (object)
An extension object type #Element.
- `occurrenceTiming` (object)
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
- `occurrenceTiming.modifierExtension` (array)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- `occurrenceTiming.event` (array)
Identifies specific times when the event occurs.
Example: ["2024-01-01T00:00:00Z"]
- `occurrenceTiming._event` (array)
Extensions for event
- `occurrenceTiming.repeat` (object)
An extension object type #Timing_Repeat.
- `occurrenceTiming.code` (object)
An extension object type #CodeableConcept.
- `asNeededBoolean` (boolean)
If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
Example: true
- `_asNeededBoolean` (object)
Base definition for all elements in a resource.
- `asNeededCodeableConcept` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `authoredOn` (string)
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
- `_authoredOn` (object)
Base definition for all elements in a resource.
- `requester` (object)
A reference from one resource to another.
- `performerType` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `performer` (array)
The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
- `locationCode` (array)
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.
- `locationReference` (array)
A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
- `reasonCode` (array)
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.
- `reasonReference` (array)
Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in supportingInfo.
- `insurance` (array)
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
- `supportingInfo` (array)
Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
- `specimen` (array)
One or more specimens that the laboratory procedure will use.
- `bodySite` (array)
Anatomic location where the procedure should be performed. This is the target site.
- `note` (array)
Any other notes and comments made about the service request. For example, internal billing notes.
- `note.authorReference` (object)
An extension object type #Reference.
- `note.authorString` (string)
The individual responsible for making the annotation.
Example: "example-string"
- `note._authorString` (object)
An extension object type #Element.
- `note.time` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `note._time` (object)
An extension object type #Element.
- `note.text` (object)
An extension object type #markdown.
- `patientInstruction` (string)
A sequence of Unicode characters
Example: "example-string"
- `_patientInstruction` (object)
Base definition for all elements in a resource.
- `relevantHistory` (array)
Key events in the history of the request.
## Response 200 fields (application/json):
- `resourceType` (any, required)
This is a ServiceRequest resource
Enum: "ServiceRequest"
- `id` (string)
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
- `meta` (object)
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- `meta.id` (string)
An extension object type #string.
Example: "example-string"
- `meta.extension` (array)
May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- `meta.versionId` (object)
An extension object type #id.
- `meta._versionId` (object)
An extension object type #Element.
- `meta.lastUpdated` (object)
An extension object type #instant.
- `meta._lastUpdated` (object)
An extension object type #Element.
- `meta.source` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `meta._source` (object)
An extension object type #Element.
- `meta.profile` (array)
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
Example: ["http://example.org/Profile"]
- `meta.security` (array)
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
- `meta.tag` (array)
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
- `implicitRules` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_implicitRules` (object)
Base definition for all elements in a resource.
- `language` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_language` (object)
Base definition for all elements in a resource.
- `text` (object)
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
- `text.status` (any)
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Enum: "generated", "extensions", "additional", "empty"
- `text._status` (object)
An extension object type #Element.
- `text.div` (string, required)
An extension object type #xhtml.
Example: "Example
"
- `contained` (array)
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.
- `extension` (array)
May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- `extension.url` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `extension._url` (object)
An extension object type #Element.
- `extension.valueBase64Binary` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "U2FtcGxl"
- `extension._valueBase64Binary` (object)
An extension object type #Element.
- `extension.valueBoolean` (boolean)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: true
- `extension._valueBoolean` (object)
An extension object type #Element.
- `extension.valueCanonical` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "http://example.org/Profile"
- `extension._valueCanonical` (object)
An extension object type #Element.
- `extension.valueCode` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "sample-code"
- `extension._valueCode` (object)
An extension object type #Element.
- `extension.valueDate` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01"
- `extension._valueDate` (object)
An extension object type #Element.
- `extension.valueDateTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueDateTime` (object)
An extension object type #Element.
- `extension.valueDecimal` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1.23
- `extension._valueDecimal` (object)
An extension object type #Element.
- `extension.valueId` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-id"
- `extension._valueId` (object)
An extension object type #Element.
- `extension.valueInstant` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueInstant` (object)
An extension object type #Element.
- `extension.valueInteger` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valueInteger` (object)
An extension object type #Element.
- `extension.valueMarkdown` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "Sample markdown text"
- `extension._valueMarkdown` (object)
An extension object type #Element.
- `extension.valueOid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:oid:1.2.3.4.5"
- `extension._valueOid` (object)
An extension object type #Element.
- `extension.valuePositiveInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valuePositiveInt` (object)
An extension object type #Element.
- `extension.valueString` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-string"
- `extension._valueString` (object)
An extension object type #Element.
- `extension.valueTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "12:00:00"
- `extension._valueTime` (object)
An extension object type #Element.
- `extension.valueUnsignedInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
- `extension._valueUnsignedInt` (object)
An extension object type #Element.
- `extension.valueUri` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org/resource"
- `extension._valueUri` (object)
An extension object type #Element.
- `extension.valueUrl` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org"
- `extension._valueUrl` (object)
An extension object type #Element.
- `extension.valueUuid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
- `extension._valueUuid` (object)
An extension object type #Element.
- `extension.valueAddress` (object)
An extension object type #Address.
- `extension.valueAge` (object)
An extension object type #Age.
- `extension.valueAnnotation` (object)
An extension object type #Annotation.
- `extension.valueAttachment` (object)
An extension object type #Attachment.
- `extension.valueCodeableConcept` (object)
An extension object type #CodeableConcept.
- `extension.valueCoding` (object)
An extension object type #Coding.
- `extension.valueContactPoint` (object)
An extension object type #ContactPoint.
- `extension.valueCount` (object)
An extension object type #Count.
- `extension.valueDistance` (object)
An extension object type #Distance.
- `extension.valueDuration` (object)
An extension object type #Duration.
- `extension.valueHumanName` (object)
An extension object type #HumanName.
- `extension.valueIdentifier` (object)
An extension object type #Identifier.
- `extension.valueMoney` (object)
An extension object type #Money.
- `extension.valuePeriod` (object)
An extension object type #Period.
- `extension.valueQuantity` (object)
An extension object type #Quantity.
- `extension.valueRange` (object)
An extension object type #Range.
- `extension.valueRatio` (object)
An extension object type #Ratio.
- `extension.valueReference` (object)
An extension object type #Reference.
- `extension.valueSampledData` (object)
An extension object type #SampledData.
- `extension.valueSignature` (object)
An extension object type #Signature.
- `extension.valueTiming` (object)
An extension object type #Timing.
- `extension.valueContactDetail` (object)
An extension object type #ContactDetail.
- `extension.valueContributor` (object)
An extension object type #Contributor.
- `extension.valueDataRequirement` (object)
An extension object type #DataRequirement.
- `extension.valueExpression` (object)
An extension object type #Expression.
- `extension.valueParameterDefinition` (object)
An extension object type #ParameterDefinition.
- `extension.valueRelatedArtifact` (object)
An extension object type #RelatedArtifact.
- `extension.valueTriggerDefinition` (object)
An extension object type #TriggerDefinition.
- `extension.valueUsageContext` (object)
An extension object type #UsageContext.
- `extension.valueDosage` (object)
An extension object type #Dosage.
- `extension.valueMeta` (object)
An extension object type #Meta.
- `modifierExtension` (array)
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.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- `identifier` (array)
Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
- `identifier.use` (any)
The purpose of this identifier.
Enum: "usual", "official", "temp", "secondary", "old"
- `identifier._use` (object)
An extension object type #Element.
- `identifier.type` (object)
An extension object type #CodeableConcept.
- `identifier.system` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `identifier._system` (object)
An extension object type #Element.
- `identifier.value` (string)
An extension object type #string.
Example: "example-string"
- `identifier._value` (object)
An extension object type #Element.
- `identifier.period` (object)
An extension object type #Period.
- `identifier.assigner` (object)
An extension object type #Reference.
- `instantiatesCanonical` (array)
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
Example: ["http://example.org/Profile"]
- `instantiatesUri` (array)
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.
Example: ["https://example.org/resource"]
- `_instantiatesUri` (array)
Extensions for instantiatesUri
- `basedOn` (array)
Plan/proposal/order fulfilled by this request.
- `basedOn.reference` (string)
An extension object type #string.
Example: "example-string"
- `basedOn._reference` (object)
An extension object type #Element.
- `basedOn.type` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `basedOn._type` (object)
An extension object type #Element.
- `basedOn.identifier` (object)
An extension object type #Identifier.
- `basedOn.display` (string)
An extension object type #string.
Example: "example-string"
- `basedOn._display` (object)
An extension object type #Element.
- `replaces` (array)
The request takes the place of the referenced completed or terminated request(s).
- `requisition` (object)
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
- `status` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_status` (object)
Base definition for all elements in a resource.
- `intent` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_intent` (object)
Base definition for all elements in a resource.
- `category` (array)
A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
Example: [{"coding":[{"system":"http://snomed.info/sct","code":"103693007","display":"Diagnostic procedure (procedure)"}],"text":"Diagnostics Procedure"}]
- `category.coding` (array)
A reference to a code defined by a terminology system.
- `category.text` (string)
An extension object type #string.
Example: "example-string"
- `category._text` (object)
An extension object type #Element.
- `priority` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_priority` (object)
Base definition for all elements in a resource.
- `doNotPerform` (boolean)
Value of "true" or "false"
Example: true
- `_doNotPerform` (object)
Base definition for all elements in a resource.
- `code` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `orderDetail` (array)
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.
- `quantityQuantity` (object)
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
- `quantityQuantity.value` (number)
An extension object type #decimal.
Example: 1.23
- `quantityQuantity.comparator` (any)
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Enum: "<", "<=", ">=", ">"
- `quantityQuantity._comparator` (object)
An extension object type #Element.
- `quantityQuantity.unit` (string)
An extension object type #string.
Example: "example-string"
- `quantityQuantity._unit` (object)
An extension object type #Element.
- `quantityQuantity.code` (string)
An extension object type #code.
Example: "sample-code"
- `quantityQuantity._code` (object)
An extension object type #Element.
- `quantityRatio` (object)
A relationship of two Quantity values - expressed as a numerator and a denominator.
- `quantityRatio.numerator` (object)
An extension object type #Quantity.
- `quantityRatio.denominator` (object)
An extension object type #Quantity.
- `quantityRange` (object)
A set of ordered Quantities defined by a low and high limit.
- `quantityRange.low` (object)
An extension object type #Quantity.
- `quantityRange.high` (object)
An extension object type #Quantity.
- `subject` (object, required)
A reference from one resource to another.
- `encounter` (object)
A reference from one resource to another.
- `occurrenceDateTime` (string)
The date/time at which the requested service should occur.
Example: "example-string"
- `_occurrenceDateTime` (object)
Base definition for all elements in a resource.
- `occurrencePeriod` (object)
A time period defined by a start and end date and optionally time.
- `occurrencePeriod.start` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `occurrencePeriod._start` (object)
An extension object type #Element.
- `occurrencePeriod.end` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `occurrencePeriod._end` (object)
An extension object type #Element.
- `occurrenceTiming` (object)
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
- `occurrenceTiming.modifierExtension` (array)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- `occurrenceTiming.event` (array)
Identifies specific times when the event occurs.
Example: ["2024-01-01T00:00:00Z"]
- `occurrenceTiming._event` (array)
Extensions for event
- `occurrenceTiming.repeat` (object)
An extension object type #Timing_Repeat.
- `occurrenceTiming.code` (object)
An extension object type #CodeableConcept.
- `asNeededBoolean` (boolean)
If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
Example: true
- `_asNeededBoolean` (object)
Base definition for all elements in a resource.
- `asNeededCodeableConcept` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `authoredOn` (string)
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
- `_authoredOn` (object)
Base definition for all elements in a resource.
- `requester` (object)
A reference from one resource to another.
- `performerType` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `performer` (array)
The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
- `locationCode` (array)
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.
- `locationReference` (array)
A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
- `reasonCode` (array)
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.
- `reasonReference` (array)
Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in supportingInfo.
- `insurance` (array)
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
- `supportingInfo` (array)
Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
- `specimen` (array)
One or more specimens that the laboratory procedure will use.
- `bodySite` (array)
Anatomic location where the procedure should be performed. This is the target site.
- `note` (array)
Any other notes and comments made about the service request. For example, internal billing notes.
- `note.authorReference` (object)
An extension object type #Reference.
- `note.authorString` (string)
The individual responsible for making the annotation.
Example: "example-string"
- `note._authorString` (object)
An extension object type #Element.
- `note.time` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `note._time` (object)
An extension object type #Element.
- `note.text` (object)
An extension object type #markdown.
- `patientInstruction` (string)
A sequence of Unicode characters
Example: "example-string"
- `_patientInstruction` (object)
Base definition for all elements in a resource.
- `relevantHistory` (array)
Key events in the history of the request.
## Response 401 fields (application/json):
- `message` (string, required)
Error message indicating unauthorized access.
Example: "Unauthorized"
- `statusCode` (number, required)
HTTP status code for unauthorized access.
Example: 401
## Response 400 fields
## Response 404 fields