HDR FHIR API

GET PractitionerRole Resource Bundle

get

/oracle-fhir-server/fhir/PractitionerRole

This endpoint supports the retrieval of PractitionerRole resource list.It returns Bundle of PractitionerRole 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

Whether this practitioner role record is in active use
date(optional): string(date)

The period during which the practitioner is authorized to perform in these role(s)
email(optional): string

A value in an email contact
endpoint(optional): string

Technical endpoints providing access to services operated for the practitioner with this role
identifier(optional): string

A practitioner's Identifier
location(optional): string

One of the locations at which this practitioner provides care
organization(optional): string

The identity of the organization the practitioner represents / acts on behalf of
phone(optional): string

A value in a phone contact
practitioner(optional): string

Practitioner that is able to provide the defined services for the organization
role(optional): string

The practitioner can perform this role at for the organization
service(optional): string

The list of healthcare services that this worker provides for this role's Organization/Location(s)
specialty(optional): string

The practitioner has this specialty at an organization
telecom(optional): string

The value in any kind of contact

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object PractitionerRole

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

Nested Schema : PractitionerRole

Type: object

Show Source

active: boolean
availabilityExceptions: string

Minimum Length: 1
availableTime: array availableTime

Minimum Number of Items: 1

Unique Items Required: true
code: array code

Minimum Number of Items: 1

Unique Items Required: true
endpoint: array endpoint

Minimum Number of Items: 1

Unique Items Required: true
healthcareService: array healthcareService

Minimum Number of Items: 1

Unique Items Required: true
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
notAvailable: array notAvailable

Minimum Number of Items: 1

Unique Items Required: true
organization: object Account_coverage
period: object Account_servicePeriod
practitioner: object Account_subject
resourceType: string

Minimum Length: 1
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":"object",
    "required":[
        "active",
        "availabilityExceptions",
        "availableTime",
        "code",
        "endpoint",
        "healthcareService",
        "id",
        "identifier",
        "location",
        "meta",
        "notAvailable",
        "organization",
        "period",
        "practitioner",
        "resourceType",
        "specialty",
        "telecom",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "active":{
            "type":"boolean"
        },
        "period":{
            "$ref":"#/definitions/Account_servicePeriod"
        },
        "practitioner":{
            "$ref":"#/definitions/Account_subject"
        },
        "organization":{
            "$ref":"#/definitions/Account_coverage"
        },
        "code":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "specialty":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "location":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        },
        "healthcareService":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "telecom":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_telecom"
            },
            "minItems":1
        },
        "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 : code

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_jurisdiction

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_jurisdiction"
    },
    "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 : healthcareService

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_subject

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_subject"
    },
    "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 : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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

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

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/ActivityDefinition_code"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

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

Nested Schema : ActivityDefinition_code

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "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 : 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_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 : 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
        }
    }
}