Jump to

• Request
• Response

Get a list of conditions

get

/Condition

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

• Search by _id, or by patient/subject with optional filters.
• Do not combine _id with other filters except _revinclude.
• Do not combine patient and subject.

Request

Query Parameters

• _count: integer
  Minimum Value: 1

  Maximum Value: 128

  The maximum number of results per page.

  Default Value: 50
• _id: string
  The logical resource ID.
• _lastUpdated: array[string]
  Minimum Number of Items: 1

  Maximum Number of Items: 2

  The last updated date or range.
• _revinclude: string
  The inclusion of related Provenance resources.

  Allowed Values: [ "Provenance:target" ]
• category: string
  One or more comma-delimited category tokens.
• clinical-status: string
  One or more comma-delimited clinical status tokens.
• encounter: string
  One or more comma-delimited Encounter references or IDs.
• patient: string
  The patient reference or ID.
• subject: string
  The patient subject reference or 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 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":{
                "$ref":"#/components/schemas/BundleEntryForCondition"
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object BundleEntryForCondition

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

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

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

Nested Schema : BundleEntryForCondition

Type: object

Show Source

• fullUrl: string
• resource: resource
• search: object BundleEntrySearch

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string"
        },
        "resource":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Condition"
                },
                {
                    "$ref":"#/components/schemas/ProvenanceForCondition"
                },
                {
                    "$ref":"#/components/schemas/OperationOutcome"
                }
            ]
        },
        "search":{
            "$ref":"#/components/schemas/BundleEntrySearch"
        }
    }
}

Nested Schema : resource

Match One Schema

Show Source

• object Condition
  The FHIR R4 Condition resource.
• object ProvenanceForCondition
  Additional Properties Allowed: true

  The included FHIR Provenance resource.
• object OperationOutcome
  The FHIR OperationOutcome.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/Condition"
        },
        {
            "$ref":"#/components/schemas/ProvenanceForCondition"
        },
        {
            "$ref":"#/components/schemas/OperationOutcome"
        }
    ]
}

Nested Schema : BundleEntrySearch

Type: object

Show Source

• mode: string

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

Nested Schema : Condition

Type: object

The FHIR R4 Condition resource.

Show Source

• abatementDateTime: string
  The FHIR dateTime, including supported partial-date precision.
• category(required): array category
• clinicalStatus: object CodeableConcept
• code(required): object CodeableConcept
• encounter: object ReferenceForCondition
• extension: array extension
• id(required): string
• identifier: array identifier
• meta: object meta
• note: array note
• onsetDateTime: string
  The FHIR dateTime, including supported partial-date precision.
• recordedDate: string (date-time)
• recorder: object ReferenceForCondition
• resourceType(required): string
  Allowed Values: [ "Condition" ]
• severity: object CodeableConcept
• subject(required): object ReferenceForCondition
• text: object Narrative
• verificationStatus: object CodeableConcept

{
    "type":"object",
    "description":"The FHIR R4 Condition resource.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Condition"
            ]
        },
        "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"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForCondition"
            }
        },
        "identifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        },
        "clinicalStatus":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "verificationStatus":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "severity":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForCondition"
        },
        "encounter":{
            "$ref":"#/components/schemas/ReferenceForCondition"
        },
        "onsetDateTime":{
            "type":"string",
            "description":"The FHIR <code>dateTime</code>, including supported partial-date precision."
        },
        "abatementDateTime":{
            "type":"string",
            "description":"The FHIR <code>dateTime</code>, including supported partial-date precision."
        },
        "recordedDate":{
            "type":"string",
            "format":"date-time"
        },
        "recorder":{
            "$ref":"#/components/schemas/ReferenceForCondition"
        },
        "note":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AnnotationForCondition"
            }
        }
    },
    "required":[
        "resourceType",
        "id",
        "category",
        "code",
        "subject"
    ]
}

Nested Schema : ProvenanceForCondition

Type: object

Additional Properties Allowed: true

The included FHIR Provenance resource.

Show Source

• resourceType: string
  Allowed Values: [ "Provenance" ]

{
    "type":"object",
    "description":"The included FHIR Provenance resource.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Provenance"
            ]
        }
    },
    "additionalProperties":true
}

Nested 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 : 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 : ReferenceForCondition

Type: object

Show Source

• display: string
• reference: string
• type: string

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

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForCondition

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

Nested Schema : identifier

Type: array

Show Source

• Array of: object Identifier

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

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 AnnotationForCondition

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

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

Type: object

Show Source

• url: string (uri)
• valueCodeableConcept: object CodeableConcept
• valueDateTime: string
  The FHIR dateTime, including supported partial-date precision.

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueDateTime":{
            "type":"string",
            "description":"The FHIR <code>dateTime</code>, including supported partial-date precision."
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : Identifier

Type: object

Show Source

• period: object Period
• system: string
• type: object CodeableConcept
• use: string
• value: string

{
    "type":"object",
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "system":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

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

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

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

Nested Schema : AnnotationForCondition

Type: object

Show Source

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

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

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

Type: array

Show Source

• Array of: string

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

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]

  The link relation.
• url: string
  The link URL.

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ],
            "description":"The link relation."
        },
        "url":{
            "type":"string",
            "description":"The link URL."
        }
    }
}

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