HDR FHIR API

GET Consent Resource Bundle

get

/oracle-fhir-server/fhir/Consent

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
action(optional): string

Actions controlled by this rule
actor(optional): string

Resource for the actor (or group, by role)
category(optional): string

Classification of the consent statement - for indexing/retrieval
consentor(optional): string

Who is agreeing to the policy and rules
data(optional): string

The actual data reference
date(optional): string(date)

When this Consent was created or indexed
identifier(optional): string

Identifier for this record (external references)
organization(optional): string

Custodian of the consent
patient(optional): string

Who the consent applies to
period(optional): string(date)

Timeframe for this rule
purpose(optional): string

Context of activities covered by this rule
scope(optional): string

Which of the four areas this resource covers (extensible)
security-label(optional): string

Security Labels that define affected resources
source-reference(optional): string

Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse
status(optional): string

draft | proposed | active | rejected | inactive | entered-in-error

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Consent

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

Nested Schema : Consent

Type: object

Show Source

category: array category

Minimum Number of Items: 1

Unique Items Required: true
dateTime: string

Minimum Length: 1
id: string

Minimum Length: 1
meta: object Account_meta
organization: array organization

Minimum Number of Items: 1

Unique Items Required: true
patient: object Account_subject
policyRule: object Basic_code
provision: object Consent_provision
resourceType: string

Minimum Length: 1
scope: object Basic_code
sourceAttachment: object Consent_sourceAttachment
status: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "category",
        "dateTime",
        "id",
        "meta",
        "organization",
        "patient",
        "policyRule",
        "provision",
        "resourceType",
        "scope",
        "sourceAttachment",
        "status",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "scope":{
            "$ref":"#/definitions/Basic_code"
        },
        "category":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "patient":{
            "$ref":"#/definitions/Account_subject"
        },
        "dateTime":{
            "type":"string",
            "minLength":1
        },
        "organization":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "sourceAttachment":{
            "$ref":"#/definitions/Consent_sourceAttachment"
        },
        "policyRule":{
            "$ref":"#/definitions/Basic_code"
        },
        "provision":{
            "$ref":"#/definitions/Consent_provision"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : category

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

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

Type: object

Show Source

period: object Account_servicePeriod

{
    "required":[
        "period"
    ],
    "properties":{
        "period":{
            "$ref":"#/definitions/Account_servicePeriod"
        }
    }
}

Nested Schema : Consent_sourceAttachment

Type: object

Show Source

title: string

Minimum Length: 1

{
    "required":[
        "title"
    ],
    "properties":{
        "title":{
            "type":"string",
            "minLength":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 : 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 : 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 : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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