Jump to

• Request
• Response

Get a service request by ID

get

/ServiceRequest/{id}

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

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 credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful retrieve response.

Body ()

Root Schema : ServiceRequest

Type: object

Show Source

• authoredOn: string (date-time)
  (USCDI) The date when the request is signed.
• bodySite: array bodySite
  The location on the body.
• category: array category
  (USCDI) The classification of the service.
• code(required): code
  (USCDI) What is being requested or ordered.
• id(required): string
• intent(required): string
  (USCDI) The following values are supported:

  • proposal
  • plan
  • directive
  • order
  • original-order
  • reflex-order
  • filler-order
  • instance-order
  • option
• occurrenceDateTime: string (date-time)
  (USCDI) When the service should occur.
• occurrencePeriod: occurrencePeriod
  (USCDI) When the service should occur.
• occurrenceTiming: occurrenceTiming
  (USCDI) When the service should occur.
• performer: array performer
  The requested performer.
• reasonCode: array reasonCode
  (USCDI) The explanation or justification for the procedure or service.
• reasonReference: array reasonReference
  (USCDI) The U.S. Core profile that supports the requested service.
• requester: requester
  (USCDI) Who or what is requesting service.
• resourceType(required): string
  Allowed Values: [ "ServiceRequest" ]
• specimen: array specimen
  The procedure samples.
• status(required): string
  (USCDI) The following values are supported:

  • draft
  • active
  • on-hold
  • revoked
  • completed
  • entered-in-error
  • unknown
• subject(required): subject
  (USCDI) The individual or entity the service is ordered for.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "status",
        "intent",
        "code",
        "subject"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "ServiceRequest"
            ]
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>draft</code></li>\n    <li><code>active</code></li>\n    <li><code>on-hold</code></li>\n    <li><code>revoked</code></li>\n    <li><code>completed</code></li>\n    <li><code>entered-in-error</code></li>\n    <li><code>unknown</code></li>\n  </ul>\n"
        },
        "intent":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>proposal</code></li>\n    <li><code>plan</code></li>\n    <li><code>directive</code></li>\n    <li><code>order</code></li>\n    <li><code>original-order</code></li>\n    <li><code>reflex-order</code></li>\n    <li><code>filler-order</code></li>\n    <li><code>instance-order</code></li>\n    <li><code>option</code></li>\n  </ul>\n"
        },
        "category":{
            "type":"array",
            "description":"(USCDI) The classification of the service.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "code":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) What is being requested or ordered."
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The individual or entity the service is ordered for."
        },
        "occurrenceDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) When the service should occur."
        },
        "occurrencePeriod":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Period"
                }
            ],
            "description":"(USCDI) When the service should occur."
        },
        "occurrenceTiming":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Timing"
                }
            ],
            "description":"(USCDI) When the service should occur."
        },
        "authoredOn":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The date when the request is signed."
        },
        "requester":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) Who or what is requesting service."
        },
        "performer":{
            "type":"array",
            "description":"The requested performer.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "reasonCode":{
            "type":"array",
            "description":"(USCDI) The explanation or justification for the procedure or service.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "reasonReference":{
            "type":"array",
            "description":"(USCDI) The U.S. Core profile that supports the requested service.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "specimen":{
            "type":"array",
            "description":"The procedure samples.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "bodySite":{
            "type":"array",
            "description":"The location on the body.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        }
    }
}

Nested Schema : bodySite

Type: array

The location on the body.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"The location on the body.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : category

Type: array

(USCDI) The classification of the service.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"(USCDI) The classification of the service.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : code

(USCDI) What is being requested or ordered.

Match All

(USCDI) What is being requested or ordered.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) What is being requested or ordered."
}

Nested Schema : occurrencePeriod

(USCDI) When the service should occur.

Match All

(USCDI) When the service should occur.

Show Source

• object Period

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Period"
        }
    ],
    "description":"(USCDI) When the service should occur."
}

Nested Schema : occurrenceTiming

(USCDI) When the service should occur.

Match All

(USCDI) When the service should occur.

Show Source

• object Timing

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Timing"
        }
    ],
    "description":"(USCDI) When the service should occur."
}

Nested Schema : performer

Type: array

The requested performer.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"The requested performer.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : reasonCode

Type: array

(USCDI) The explanation or justification for the procedure or service.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"(USCDI) The explanation or justification for the procedure or service.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : reasonReference

Type: array

(USCDI) The U.S. Core profile that supports the requested service.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"(USCDI) The U.S. Core profile that supports the requested service.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : requester

(USCDI) Who or what is requesting service.

Match All

(USCDI) Who or what is requesting service.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) Who or what is requesting service."
}

Nested Schema : specimen

Type: array

The procedure samples.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"The procedure samples.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : subject

(USCDI) The individual or entity the service is ordered for.

Match All

(USCDI) The individual or entity the service is ordered for.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The individual or entity the service is ordered for."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

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

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string (date-time)
• start: string (date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : Timing

Type: object

Show Source

• event: array event

{
    "type":"object",
    "properties":{
        "event":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"date-time"
            }
        }
    }
}

Nested Schema : event

Type: array

Show Source

• Array of: string(date-time)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"date-time"
    }
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top