FHIR R4 APIs for Oracle Health AI Application Suite

Get a list of family member histories

get

/FamilyMemberHistory

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 family member histories that meet the supplied query parameters.

Use _id or patient, not both.
Use status only with patient.

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]

Maximum Number of Items: 2

The last updated date or range.
patient: string

The patient reference or ID.
status: string

The family member history status.

Allowed Values: [ "partial", "completed", "entered-in-error", "health-unknown" ]

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.

Response

200 Response

The successful search response.

Root Schema : schema

Type: object

Show Source

entry: array entry
id(required): string
link: array link
resourceType(required): string

Allowed Values: [ "Bundle" ]
total: integer
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/BundleEntryForFamilyMemberHistory"
            }
        },
        "total":{
            "type":"integer"
        }
    }
}

Nested Schema : entry

Type: array

Show Source

Array of: object BundleEntryForFamilyMemberHistory

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

Nested Schema : link

Type: array

Show Source

Array of: object BundleLink

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

Nested Schema : BundleEntryForFamilyMemberHistory

Type: object

Show Source

fullUrl: string (uri)
resource: resource
search: object BundleEntrySearch

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

Nested Schema : resource

Match One Schema

Show Source

object FamilyMemberHistory

The FHIR R4 FamilyMemberHistory resource.
object OperationOutcome

The FHIR OperationOutcome.

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

Nested Schema : BundleEntrySearch

Type: object

Show Source

mode: string

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

Nested Schema : FamilyMemberHistory

Type: object

The FHIR R4 FamilyMemberHistory resource.

Show Source

ageAge: object AgeForFamilyMemberHistory
ageString: string
bornDate: string
bornPeriod: object Period
bornString: string
condition: array condition
dataAbsentReason: object CodeableConcept
date: string (date-time)
deceasedBoolean: boolean
estimatedAge: boolean
id(required): string
name: string
patient(required): object ReferenceForFamilyMemberHistory
relationship(required): object CodeableConcept
resourceType(required): string

Allowed Values: [ "FamilyMemberHistory" ]
sex: object CodeableConcept
status(required): string

Allowed Values: [ "partial", "completed", "entered-in-error", "health-unknown" ]
text: object Narrative

{
    "type":"object",
    "description":"The FHIR R4 FamilyMemberHistory resource.",
    "required":[
        "resourceType",
        "status",
        "patient",
        "relationship",
        "id"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "FamilyMemberHistory"
            ]
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "partial",
                "completed",
                "entered-in-error",
                "health-unknown"
            ]
        },
        "dataAbsentReason":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "patient":{
            "$ref":"#/components/schemas/ReferenceForFamilyMemberHistory"
        },
        "date":{
            "type":"string",
            "format":"date-time"
        },
        "name":{
            "type":"string"
        },
        "relationship":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "sex":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "bornPeriod":{
            "$ref":"#/components/schemas/Period"
        },
        "bornDate":{
            "type":"string"
        },
        "bornString":{
            "type":"string"
        },
        "ageAge":{
            "$ref":"#/components/schemas/AgeForFamilyMemberHistory"
        },
        "ageString":{
            "type":"string"
        },
        "estimatedAge":{
            "type":"boolean"
        },
        "deceasedBoolean":{
            "type":"boolean"
        },
        "condition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConditionForFamilyMemberHistory"
            }
        }
    }
}

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

Type: object

Show Source

code: string
extension: array extension
system: string (uri)
unit: string
value: number

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForFamilyMemberHistory"
            }
        },
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string"
        },
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        }
    }
}

Nested Schema : Period

Type: object

Show Source

end: string
start: string

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

Nested Schema : condition

Type: array

Show Source

Array of: object ConditionForFamilyMemberHistory

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

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

Type: object

Show Source

display: string
reference: string

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

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

Type: array

Show Source

Array of: object ExtensionForFamilyMemberHistory

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

Nested Schema : ExtensionForFamilyMemberHistory

Type: object

Show Source

url(required): string (uri)
valueCodeableConcept: object CodeableConcept

{
    "type":"object",
    "required":[
        "url"
    ],
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : ConditionForFamilyMemberHistory

Type: object

Show Source

code(required): object CodeableConcept
extension: array extension
id: string
modifierExtension: array modifierExtension
note: array note
onsetAge: object AgeForFamilyMemberHistory
onsetString: string

{
    "type":"object",
    "required":[
        "code"
    ],
    "properties":{
        "id":{
            "type":"string"
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForFamilyMemberHistory"
            }
        },
        "modifierExtension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForFamilyMemberHistory"
            }
        },
        "onsetAge":{
            "$ref":"#/components/schemas/AgeForFamilyMemberHistory"
        },
        "onsetString":{
            "type":"string"
        },
        "note":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AnnotationForFamilyMemberHistory"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

Array of: object ExtensionForFamilyMemberHistory

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

Nested Schema : modifierExtension

Type: array

Show Source

Array of: object ExtensionForFamilyMemberHistory

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

Nested Schema : note

Type: array

Show Source

Array of: object AnnotationForFamilyMemberHistory

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

Nested Schema : AnnotationForFamilyMemberHistory

Type: object

Show Source

authorReference: object ReferenceForFamilyMemberHistory
text(required): string
time: string (date-time)

{
    "type":"object",
    "required":[
        "text"
    ],
    "properties":{
        "authorReference":{
            "$ref":"#/components/schemas/ReferenceForFamilyMemberHistory"
        },
        "time":{
            "type":"string",
            "format":"date-time"
        },
        "text":{
            "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"
        }
    }
}

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.

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"
        }
    }
}