Jump to

• Request
• Response

Get a condition by ID

get

/Condition/{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 condition 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 : 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 : 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"
        }
    }
}

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