Jump to

• Request
• Response

Get a service request by ID

get

/ServiceRequest/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves an individual service request by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful retrieve response.

Body ()

Root Schema : ServiceRequest

Type: object

Additional Properties Allowed: true

The Oracle US Core ServiceRequest returned by read and search operations. Public properties are limited to the supported profile fields.

Show Source

• asNeededBoolean: boolean
• authoredOn: string (date-time)
• basedOn: array basedOn
• bodySite: array bodySite
• category: array category
• code(required): object CodeableConcept
• doNotPerform: boolean
• encounter: object ReferenceForServiceRequest
• id(required): string
• intent(required): string
• locationReference: array locationReference
• meta: object meta
• note: array note
• occurrenceDateTime: string (date-time)
• occurrencePeriod: object Period
• occurrenceTiming: object Timing
• orderDetail: array orderDetail
• patientInstruction: string
• performer: array performer
• priority: string
• quantityQuantity: object Quantity
• quantityRange: object Range
• quantityRatio: object Ratio
• reasonCode: array reasonCode
• reasonReference: array reasonReference
• requester: object ReferenceForServiceRequest
• resourceType(required): string
  Allowed Values: [ "ServiceRequest" ]
• status(required): string
  Allowed Values: [ "draft", "active", "on-hold", "revoked", "completed", "entered-in-error", "unknown" ]
• subject(required): object ReferenceForServiceRequest
• text(required): object Narrative

{
    "type":"object",
    "description":"The Oracle US Core ServiceRequest returned by read and search operations. Public properties are limited to the supported profile fields.",
    "required":[
        "resourceType",
        "id",
        "text",
        "status",
        "intent",
        "code",
        "subject"
    ],
    "additionalProperties":true,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "ServiceRequest"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "basedOn":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForServiceRequest"
            }
        },
        "status":{
            "type":"string",
            "enum":[
                "draft",
                "active",
                "on-hold",
                "revoked",
                "completed",
                "entered-in-error",
                "unknown"
            ]
        },
        "intent":{
            "type":"string"
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "priority":{
            "type":"string"
        },
        "doNotPerform":{
            "type":"boolean"
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "orderDetail":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "quantityQuantity":{
            "$ref":"#/components/schemas/Quantity"
        },
        "quantityRatio":{
            "$ref":"#/components/schemas/Ratio"
        },
        "quantityRange":{
            "$ref":"#/components/schemas/Range"
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForServiceRequest"
        },
        "encounter":{
            "$ref":"#/components/schemas/ReferenceForServiceRequest"
        },
        "occurrenceDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "occurrencePeriod":{
            "$ref":"#/components/schemas/Period"
        },
        "occurrenceTiming":{
            "$ref":"#/components/schemas/Timing"
        },
        "asNeededBoolean":{
            "type":"boolean"
        },
        "authoredOn":{
            "type":"string",
            "format":"date-time"
        },
        "requester":{
            "$ref":"#/components/schemas/ReferenceForServiceRequest"
        },
        "performer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForServiceRequest"
            }
        },
        "locationReference":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForServiceRequest"
            }
        },
        "reasonCode":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "reasonReference":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForServiceRequest"
            }
        },
        "bodySite":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "note":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AnnotationForServiceRequest"
            }
        },
        "patientInstruction":{
            "type":"string"
        }
    }
}

Nested Schema : basedOn

Type: array

Show Source

• Array of: object ReferenceForServiceRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForServiceRequest"
    }
}

Nested Schema : bodySite

Type: array

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : category

Type: array

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : ReferenceForServiceRequest

Type: object

Show Source

• display: string
• reference(required): string
• type: string

{
    "type":"object",
    "required":[
        "reference"
    ],
    "additionalProperties":false,
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : locationReference

Type: array

Show Source

• Array of: object ReferenceForServiceRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForServiceRequest"
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : note

Type: array

Show Source

• Array of: object AnnotationForServiceRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AnnotationForServiceRequest"
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : Timing

Type: object

Show Source

• code: object CodeableConcept
• repeat: object TimingRepeat

{
    "type":"object",
    "properties":{
        "repeat":{
            "$ref":"#/components/schemas/TimingRepeat"
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : orderDetail

Type: array

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : performer

Type: array

Show Source

• Array of: object ReferenceForServiceRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForServiceRequest"
    }
}

Nested Schema : Quantity

Type: object

Show Source

• code: string
• comparator: string
• system: string
• unit: string
• value: number

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number"
        },
        "comparator":{
            "type":"string"
        },
        "unit":{
            "type":"string"
        },
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Nested Schema : Range

Type: object

Show Source

• high: object Quantity
• low: object Quantity

{
    "type":"object",
    "properties":{
        "low":{
            "$ref":"#/components/schemas/Quantity"
        },
        "high":{
            "$ref":"#/components/schemas/Quantity"
        }
    }
}

Nested Schema : Ratio

Type: object

Show Source

• denominator: object Quantity
• numerator: object Quantity

{
    "type":"object",
    "properties":{
        "numerator":{
            "$ref":"#/components/schemas/Quantity"
        },
        "denominator":{
            "$ref":"#/components/schemas/Quantity"
        }
    }
}

Nested Schema : reasonCode

Type: array

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : reasonReference

Type: array

Show Source

• Array of: object ReferenceForServiceRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForServiceRequest"
    }
}

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : AnnotationForServiceRequest

Type: object

Show Source

• authorReference: object ReferenceForServiceRequest
• text: string
• time: string (date-time)

{
    "type":"object",
    "properties":{
        "authorReference":{
            "$ref":"#/components/schemas/ReferenceForServiceRequest"
        },
        "time":{
            "type":"string",
            "format":"date-time"
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : TimingRepeat

Type: object

Show Source

• boundsPeriod: object Period
• count: integer
• duration: number
• durationUnit: string
• when: array when

{
    "type":"object",
    "properties":{
        "boundsPeriod":{
            "$ref":"#/components/schemas/Period"
        },
        "count":{
            "type":"integer"
        },
        "duration":{
            "type":"number"
        },
        "durationUnit":{
            "type":"string"
        },
        "when":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : when

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top