HDR FHIR API

GET Provenance Resource Bundle

get

/oracle-fhir-server/fhir/Provenance

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
agent(optional): string

Who participated
agent-role(optional): string

What the agents role was
agent-type(optional): string

How the agent participated
entity(optional): string

Identity of entity
location(optional): string

Where the activity occurred, if relevant
patient(optional): string

Target Reference(s) (usually version specific)
recorded(optional): string(date)

When the activity was recorded / updated
signature-type(optional): string

Indication of the reason the entity signed the object(s)
target(optional): string

Target Reference(s) (usually version specific)
when(optional): string(date)

When the activity occurred

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Provenance

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

Nested Schema : Provenance

Type: object

Show Source

agent: array agent

Minimum Number of Items: 1

Unique Items Required: true
entity: array entity

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
location: object Account_coverage
meta: object Account_meta
occurredPeriod: object Account_servicePeriod
policy: array policy
reason: array reason

Minimum Number of Items: 1

Unique Items Required: true
recorded: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
target: array target

Minimum Number of Items: 1

Unique Items Required: true
text: object Account_text

{
    "type":"object",
    "required":[
        "agent",
        "entity",
        "id",
        "location",
        "meta",
        "occurredPeriod",
        "policy",
        "reason",
        "recorded",
        "resourceType",
        "target",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "target":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "occurredPeriod":{
            "$ref":"#/definitions/Account_servicePeriod"
        },
        "recorded":{
            "type":"string",
            "minLength":1
        },
        "policy":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "location":{
            "$ref":"#/definitions/Account_coverage"
        },
        "reason":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "agent":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Provenance_agent"
            },
            "minItems":1
        },
        "entity":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Provenance_entity"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : agent

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Provenance_agent

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

Nested Schema : entity

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Provenance_entity

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

Type: array

Show Source

Array of: object items

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

Nested Schema : reason

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

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_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 : Provenance_agent

Type: object

Show Source

id: string

Minimum Length: 1
type(optional): object Basic_code
who(optional): object Account_coverage

{
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "$ref":"#/definitions/Basic_code"
        },
        "who":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

Nested Schema : Basic_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/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 : Provenance_entity

Type: object

Show Source

role: string

Minimum Length: 1
what(optional): object Account_subject

{
    "required":[
        "role"
    ],
    "properties":{
        "role":{
            "type":"string",
            "minLength":1
        },
        "what":{
            "$ref":"#/definitions/Account_subject"
        }
    }
}

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

Type: object

Show Source

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

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
}