HDR FHIR API

GET HealthcareService Resource Bundle

get

/oracle-fhir-server/fhir/HealthcareService

This endpoint supports the retrieval of HealthcareService resource list.It returns Bundle of HealthcareService resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
active(optional): string

The Healthcare Service is currently marked as active
characteristic(optional): string

One of the HealthcareService's characteristics
coverage-area(optional): string

Location(s) service is intended for/available to
endpoint(optional): string

Technical endpoints providing access to electronic services operated for the healthcare service
identifier(optional): string

External identifiers for this item
location(optional): string

The location of the Healthcare Service
name(optional): string

A portion of the Healthcare service name
organization(optional): string

The organization that provides this Healthcare Service
program(optional): string

One of the Programs supported by this HealthcareService
service-category(optional): string

Service Category of the Healthcare Service
service-type(optional): string

The type of service provided by this healthcare service
specialty(optional): string

The specialty of the service provided by this healthcare service

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object HealthcareService

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HealthcareService"
    }
}

Nested Schema : HealthcareService

Type: object

Show Source

active: boolean
appointmentRequired: boolean
availabilityExceptions: string

Minimum Length: 1
availableTime: array availableTime

Minimum Number of Items: 1

Unique Items Required: true
category: array category

Minimum Number of Items: 1

Unique Items Required: true
characteristic: array characteristic

Minimum Number of Items: 1

Unique Items Required: true
comment: string

Minimum Length: 1
contained: array contained

Minimum Number of Items: 1

Unique Items Required: true
coverageArea: array coverageArea

Minimum Number of Items: 1

Unique Items Required: true
eligibility: array eligibility

Minimum Number of Items: 1

Unique Items Required: true
endpoint: array endpoint

Minimum Number of Items: 1

Unique Items Required: true
extraDetails: string

Minimum Length: 1
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
location: array location

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
name: string

Minimum Length: 1
notAvailable: array notAvailable

Minimum Number of Items: 1

Unique Items Required: true
program: array program

Minimum Number of Items: 1

Unique Items Required: true
providedBy: object Account_subject
referralMethod: array referralMethod

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
serviceProvisionCode: array serviceProvisionCode

Minimum Number of Items: 1

Unique Items Required: true
specialty: array specialty

Minimum Number of Items: 1

Unique Items Required: true
telecom: array telecom

Minimum Number of Items: 1

Unique Items Required: true
text: object Account_text
type: array type

Minimum Number of Items: 1

Unique Items Required: true

{
    "type":"object",
    "required":[
        "active",
        "appointmentRequired",
        "availabilityExceptions",
        "availableTime",
        "category",
        "characteristic",
        "comment",
        "contained",
        "coverageArea",
        "eligibility",
        "endpoint",
        "extraDetails",
        "id",
        "identifier",
        "location",
        "meta",
        "name",
        "notAvailable",
        "program",
        "providedBy",
        "referralMethod",
        "resourceType",
        "serviceProvisionCode",
        "specialty",
        "telecom",
        "text",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "contained":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/HealthcareService_contained"
            },
            "minItems":1
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "active":{
            "type":"boolean"
        },
        "providedBy":{
            "$ref":"#/definitions/Account_subject"
        },
        "category":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Communication_medium"
            },
            "minItems":1
        },
        "type":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "specialty":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "location":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "comment":{
            "type":"string",
            "minLength":1
        },
        "extraDetails":{
            "type":"string",
            "minLength":1
        },
        "telecom":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_telecom"
            },
            "minItems":1
        },
        "coverageArea":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        },
        "serviceProvisionCode":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "eligibility":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/HealthcareService_eligibility"
            },
            "minItems":1
        },
        "program":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "characteristic":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/HealthcareService_characteristic"
            },
            "minItems":1
        },
        "referralMethod":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Appointment_serviceType"
            },
            "minItems":1
        },
        "appointmentRequired":{
            "type":"boolean"
        },
        "availableTime":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/HealthcareService_availableTime"
            },
            "minItems":1
        },
        "notAvailable":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/HealthcareService_notAvailable"
            },
            "minItems":1
        },
        "availabilityExceptions":{
            "type":"string",
            "minLength":1
        },
        "endpoint":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : availableTime

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object HealthcareService_availableTime

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/HealthcareService_availableTime"
    },
    "minItems":1
}

Nested Schema : category

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Communication_medium

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Communication_medium"
    },
    "minItems":1
}

Nested Schema : characteristic

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object HealthcareService_characteristic

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/HealthcareService_characteristic"
    },
    "minItems":1
}

Nested Schema : contained

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object HealthcareService_contained

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/HealthcareService_contained"
    },
    "minItems":1
}

Nested Schema : coverageArea

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_subject

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_subject"
    },
    "minItems":1
}

Nested Schema : eligibility

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object HealthcareService_eligibility

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/HealthcareService_eligibility"
    },
    "minItems":1
}

Nested Schema : endpoint

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_coverage"
    },
    "minItems":1
}

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_identifier

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_identifier"
    },
    "minItems":1
}

Nested Schema : location

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_coverage"
    },
    "minItems":1
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : notAvailable

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object HealthcareService_notAvailable

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/HealthcareService_notAvailable"
    },
    "minItems":1
}

Nested Schema : program

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_topic

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_topic"
    },
    "minItems":1
}

Nested Schema : Account_subject

Type: object

Show Source

display: string

Minimum Length: 1
reference: string

Minimum Length: 1

{
    "required":[
        "display",
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : referralMethod

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Appointment_serviceType

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Appointment_serviceType"
    },
    "minItems":1
}

Nested Schema : serviceProvisionCode

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AdverseEvent_category"
    },
    "minItems":1
}

Nested Schema : specialty

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AdverseEvent_category"
    },
    "minItems":1
}

Nested Schema : telecom

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_telecom

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_telecom"
    },
    "minItems":1
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : type

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AdverseEvent_category"
    },
    "minItems":1
}

Nested Schema : HealthcareService_availableTime

Type: object

Show Source

availableEndTime: string

Minimum Length: 1
availableStartTime: string

Minimum Length: 1
daysOfWeek(optional): array daysOfWeek

{
    "required":[
        "availableEndTime",
        "availableStartTime"
    ],
    "properties":{
        "daysOfWeek":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "availableStartTime":{
            "type":"string",
            "minLength":1
        },
        "availableEndTime":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : daysOfWeek

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

Nested Schema : Communication_medium

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true
text: string

Minimum Length: 1

{
    "required":[
        "text"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        },
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : HealthcareService_characteristic

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_source_observer"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AuditEvent_source_observer

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AuditEvent_source_observer"
    },
    "minItems":1
}

Nested Schema : AuditEvent_source_observer

Type: object

Show Source

display: string

Minimum Length: 1

{
    "required":[
        "display"
    ],
    "properties":{
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : HealthcareService_contained

Type: object

Show Source

description: string

Minimum Length: 1
id: string

Minimum Length: 1
mode: string

Minimum Length: 1
physicalType(optional): object ChargeItem_code
resourceType: string

Minimum Length: 1

{
    "required":[
        "description",
        "id",
        "mode",
        "resourceType"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "mode":{
            "type":"string",
            "minLength":1
        },
        "physicalType":{
            "$ref":"#/definitions/ChargeItem_code"
        }
    }
}

Nested Schema : ChargeItem_code

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Appointment_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Appointment_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Appointment_coding"
    },
    "minItems":1
}

Nested Schema : Appointment_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1

{
    "required":[
        "code",
        "display"
    ],
    "properties":{
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : HealthcareService_eligibility

Type: object

Show Source

code(optional): object HealthcareService_code
comment: string

Minimum Length: 1

{
    "required":[
        "comment"
    ],
    "properties":{
        "code":{
            "$ref":"#/definitions/HealthcareService_code"
        },
        "comment":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : HealthcareService_code

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_source_observer"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AuditEvent_source_observer

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AuditEvent_source_observer"
    },
    "minItems":1
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_identifier

Type: object

Show Source

system: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : HealthcareService_notAvailable

Type: object

Show Source

description: string

Minimum Length: 1
during(optional): object Account_servicePeriod

{
    "required":[
        "description"
    ],
    "properties":{
        "description":{
            "type":"string",
            "minLength":1
        },
        "during":{
            "$ref":"#/definitions/Account_servicePeriod"
        }
    }
}

Nested Schema : Account_servicePeriod

Type: object

Show Source

end: string

Minimum Length: 1
start: string

Minimum Length: 1

{
    "required":[
        "end",
        "start"
    ],
    "properties":{
        "start":{
            "type":"string",
            "minLength":1
        },
        "end":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

{
    "required":[
        "text"
    ],
    "properties":{
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Appointment_serviceType

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Appointment_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Appointment_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Appointment_coding"
    },
    "minItems":1
}

Nested Schema : AdverseEvent_category

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : ActivityDefinition_telecom

Type: object

Show Source

system: string

Minimum Length: 1
use: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "use",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "type":"string",
            "minLength":1
        },
        "use":{
            "type":"string",
            "minLength":1
        }
    }
}