Jump to

• Request
• Response

Get a list of conditions

get

/Condition

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 a list of conditions that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• category: string
  A category assigned to the condition.
• patient: string
  The individual who has the condition.

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 search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/Condition"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/Condition"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

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

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object Condition
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/Condition"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : Condition

Type: object

Show Source

• abatementDateTime: string (date-time)
  (USCDI) When the condition is in resolution or remission.
• category(required): array category

  A category assigned to the condition.

  In addition to other categories, the following categories are returned:

  • For encounter diagnoses, encounter-diagnosis is returned.
  • For problems and health concerns, problem-list-item or health-concern is returned.
• clinicalStatus: clinicalStatus
  The clinical status of the condition.
• code(required): code
  (USCDI) The identification of the condition, problem, or diagnosis.
• encounter: encounter
  (USCDI) The encounter during which this condition was created or to which the creation of this record is tightly associated.
• id(required): string
• identifier: array identifier
  The external IDs for this condition.
• onsetDateTime: string (date-time)
  (USCDI) The estimated or actual date or date and time.
• recordedDate: string (date-time)
  (USCDI) The date when the record was first recorded.
• resourceType(required): string
  Allowed Values: [ "Condition" ]
• subject(required): subject
  (USCDI) The individual who has the condition.
• verificationStatus: verificationStatus
  The verification status to support the clinical status of the condition.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "category",
        "code",
        "subject"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Condition"
            ]
        },
        "id":{
            "type":"string"
        },
        "identifier":{
            "type":"array",
            "description":"The external IDs for this condition.",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        },
        "clinicalStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"The clinical status of the condition."
        },
        "verificationStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"The verification status to support the clinical status of the condition."
        },
        "category":{
            "type":"array",
            "description":"<p>A category assigned to the condition.</p>\n<p>In addition to other categories, the following categories are returned:</p>\n<ul>\n  <li>For encounter diagnoses, <code>encounter-diagnosis</code> is returned.</li>\n  <li>For problems and health concerns, <code>problem-list-item</code> or <code>health-concern</code> is returned.</li>\n</ul>\n",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "code":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The identification of the condition, problem, or diagnosis."
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The individual who has the condition."
        },
        "encounter":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The encounter during which this condition was created or to which the creation of this record is tightly associated."
        },
        "onsetDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The estimated or actual date or date and time."
        },
        "abatementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) When the condition is in resolution or remission."
        },
        "recordedDate":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The date when the record was first recorded."
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

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

Nested Schema : category

Type: array

A category assigned to the condition.

In addition to other categories, the following categories are returned:

• For encounter diagnoses, encounter-diagnosis is returned.
• For problems and health concerns, problem-list-item or health-concern is returned.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"<p>A category assigned to the condition.</p>\n<p>In addition to other categories, the following categories are returned:</p>\n<ul>\n  <li>For encounter diagnoses, <code>encounter-diagnosis</code> is returned.</li>\n  <li>For problems and health concerns, <code>problem-list-item</code> or <code>health-concern</code> is returned.</li>\n</ul>\n",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : clinicalStatus

The clinical status of the condition.

Match All

The clinical status of the condition.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"The clinical status of the condition."
}

Nested Schema : code

(USCDI) The identification of the condition, problem, or diagnosis.

Match All

(USCDI) The identification of the condition, problem, or diagnosis.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The identification of the condition, problem, or diagnosis."
}

Nested Schema : encounter

(USCDI) The encounter during which this condition was created or to which the creation of this record is tightly associated.

Match All

(USCDI) The encounter during which this condition was created or to which the creation of this record is tightly associated.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The encounter during which this condition was created or to which the creation of this record is tightly associated."
}

Nested Schema : identifier

Type: array

The external IDs for this condition.

Show Source

• Array of: object Identifier

{
    "type":"array",
    "description":"The external IDs for this condition.",
    "items":{
        "$ref":"#/components/schemas/Identifier"
    }
}

Nested Schema : subject

(USCDI) The individual who has the condition.

Match All

(USCDI) The individual who has the condition.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The individual who has the condition."
}

Nested Schema : verificationStatus

The verification status to support the clinical status of the condition.

Match All

The verification status to support the clinical status of the condition.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"The verification status to support the clinical status of the condition."
}

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 : Reference

Type: object

Show Source

• reference: string
• type: string

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

Nested Schema : Identifier

Type: object

Show Source

• system(required): string (uri)
• value(required): string

{
    "type":"object",
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

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