---
updatedAt: 2026-08-07T16:25:02.000Z
agentTools:
  projectIndex: https://docs.elationhealth.com/llms.txt
---

# Retrieve Sleep Order

Retrieve a single sleep order

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "DocumentResolutionState": {
        "properties": {
          "created_date": {
            "description": "The datetime when this resolution state was created.",
            "format": "date-time",
            "readOnly": true,
            "type": [
              "string",
              "null"
            ]
          },
          "deleted_date": {
            "description": "The datetime when this resolution was deleted. Should never be null because we're providing the most updated resolution.",
            "format": "date-time",
            "readOnly": true,
            "type": [
              "string",
              "null"
            ]
          },
          "document": {
            "description": "Will be the same as the id of the lab order.",
            "format": "int64",
            "readOnly": true,
            "type": "integer"
          },
          "id": {
            "description": "Internal id to represent the resolution state.",
            "readOnly": true,
            "type": "integer"
          },
          "note": {
            "description": "Any note that was added to represent why an order was cancelled.",
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "resolving_document": {
            "description": "If the order is fulfilled will indicate the document referenced. For lab orders will usually be a report. Must be an integer ID or null.",
            "format": "int64",
            "type": [
              "integer",
              "null"
            ]
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StateEnum"
              }
            ],
            "description": "The resolution state of the order.\n\n* `outstanding` - Outstanding\n* `fulfilled` - Fulfilled\n* `cancelled` - Cancelled"
          }
        },
        "required": [
          "state"
        ],
        "type": "object"
      },
      "ICD10Code": {
        "properties": {
          "code": {
            "maxLength": 50,
            "type": "string"
          },
          "description": {
            "maxLength": 500,
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "code"
        ],
        "type": "object"
      },
      "SleepOrder": {
        "properties": {
          "ancillary_company": {
            "format": "int64",
            "type": "integer"
          },
          "ccs": {
            "description": "Array of Physician IDs to copy for the order.",
            "items": {
              "format": "int64",
              "type": "integer"
            },
            "type": "array"
          },
          "chart_date": {
            "format": "date-time",
            "type": "string"
          },
          "clinical_reason": {
            "description": "The clinical reason for the order.",
            "type": "string"
          },
          "confidential": {
            "type": "boolean"
          },
          "created_date": {
            "format": "date-time",
            "readOnly": true,
            "type": [
              "string",
              "null"
            ]
          },
          "deleted_date": {
            "format": "date-time",
            "readOnly": true,
            "type": [
              "string",
              "null"
            ]
          },
          "document_date": {
            "format": "date-time",
            "type": "string"
          },
          "follow_up_method": {
            "description": "How to notify the patient of the results.",
            "maxLength": 100,
            "type": [
              "string",
              "null"
            ]
          },
          "icd10_codes": {
            "description": "Array of ICD-10 diagnosis codes associated with the order.",
            "items": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ICD10Code"
                }
              ]
            },
            "type": "array"
          },
          "id": {
            "readOnly": true,
            "type": "integer"
          },
          "patient": {
            "description": "The patient the order is associated with. Patient must belong to the specified practice.",
            "format": "int64",
            "type": "integer"
          },
          "practice": {
            "description": "The practice the order is associated with.",
            "format": "int64",
            "type": "integer"
          },
          "prescribing_user": {
            "description": "The user associated with the order. User ID must tie to a physician in the practice.",
            "type": "integer"
          },
          "resolution": {
            "$ref": "#/components/schemas/DocumentResolutionState"
          },
          "signed_by": {
            "format": "int64",
            "type": [
              "integer",
              "null"
            ]
          },
          "signed_date": {
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "sleep_center": {
            "description": "The sleep center the order is associated with.",
            "format": "int64",
            "type": [
              "integer",
              "null"
            ]
          },
          "test_date": {
            "description": "The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.",
            "format": "date",
            "type": [
              "string",
              "null"
            ]
          },
          "tests": {
            "description": "An array of sleep tests associated with the order.",
            "items": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/SleepOrderTest"
                }
              ]
            },
            "type": "array"
          }
        },
        "required": [
          "ancillary_company",
          "chart_date",
          "clinical_reason",
          "document_date",
          "patient",
          "practice",
          "prescribing_user",
          "tests"
        ],
        "type": "object"
      },
      "SleepOrderTest": {
        "properties": {
          "code": {
            "maxLength": 50,
            "type": [
              "string",
              "null"
            ]
          },
          "created_date": {
            "format": "date-time",
            "readOnly": true,
            "type": [
              "string",
              "null"
            ]
          },
          "deleted_date": {
            "format": "date-time",
            "readOnly": true,
            "type": [
              "string",
              "null"
            ]
          },
          "id": {
            "readOnly": true,
            "type": "integer"
          },
          "name": {
            "maxLength": 255,
            "type": "string"
          },
          "practice": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "name",
          "practice"
        ],
        "type": "object"
      },
      "StateEnum": {
        "description": "* `outstanding` - Outstanding\n* `fulfilled` - Fulfilled\n* `cancelled` - Cancelled",
        "enum": [
          "outstanding",
          "fulfilled",
          "cancelled"
        ],
        "type": "string"
      }
    },
    "securitySchemes": {
      "oauth2": {
        "flows": {
          "clientCredentials": {
            "scopes": {
              "act_as_user": "Impersonate a provider via X-On-Behalf-Of (combinable with apiv2 or system scopes)",
              "apiv2": "Full access to the API",
              "system/{resource_name}.read": "Read access to a specific resource",
              "system/{resource_name}.write": "Write access to a specific resource"
            },
            "tokenUrl": "/api/2.0/oauth2/token/"
          }
        },
        "type": "oauth2"
      }
    }
  },
  "info": {
    "contact": {
      "name": "Elation Health",
      "url": "https://www.elationhealth.com/"
    },
    "description": "Elation Health API v2.0",
    "title": "Orders API",
    "version": "2.0.0"
  },
  "openapi": "3.1.0",
  "paths": {
    "/api/2.0/sleep_orders/{id}/": {
      "get": {
        "description": "Retrieve a single sleep order",
        "operationId": "sleep_orders_retrieve",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SleepOrder"
                }
              }
            },
            "description": ""
          }
        },
        "security": [
          {
            "oauth2": []
          }
        ],
        "summary": "Retrieve Sleep Order",
        "tags": [
          "Sleep Orders"
        ],
        "x-el8-docs-category": "Orders API",
        "x-el8-docs-versions": [
          "2.1",
          "2.0"
        ]
      }
    }
  },
  "servers": [
    {
      "description": "Sandbox Server",
      "url": "https://sandbox.elationemr.com"
    },
    {
      "description": "Production Server",
      "url": "https://api.app.elationemr.com"
    }
  ],
  "x-readme": {
    "proxy-enabled": true
  }
}
```