Consent search-type

Request Fields and Example
patient
[string]

The patient to whom the consent applies

patient.identifier
[string]

One or more external identifiers for the patient

scope
[string]

Which of the areas this consent covers

category
[string]

The category of the consent

organization
[string]

The custodian organization that manages the consent

verifiedWith
[string]

Who verified the instruction (Patient, Relative or other Authorized Person).

post/Consent/_search
Response Fields and Example

Response to a Consent search operation. Unless the _include parameter is sent, only Consent resources are returned.

resourceType
required, string

Identifies the type of the resource

Value: Bundle
type
required, string

Identifies this bundle as a response to a search

Value: searchset
total
required, number

The total number of matches

entry
[Consent, Organization, RelatedPerson, Other]

A resource matching the search criteria or related to a matching resource

Any of:
resource
required, object

A record of a healthcare consumer's choices for specific purposes and periods of time.

One of:

A profile on the Consent resource that conforms to Redox requirements.

resourceType
required, string

Identifies the type of the resource

Value: Consent
status
required, string

Indicates the current state of this consent.

Possible Values: draft, proposed, active, rejected, inactive, entered-in-error
scope
required, object

A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.

coding
[object]

A reference to a code defined by a terminology system.

system
string

The identification of the code system that defines the meaning of the symbol in the code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

category
required, [object]

A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

coding
[object]

A reference to a code defined by a terminology system.

system
string

The identification of the code system that defines the meaning of the symbol in the code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

policyRule
required, object

policyRule is unsupported, but required by FHIR.

extension
[object]

Identifies this field as unsupported

url
required, string

Source of the definition for the extension code - a logical name or a URL.

Value: http://hl7.org/fhir/StructureDefinition/data-absent-reason
valueCode
required, string

The reason a required field is missing

Value: unsupported
id
string

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

identifier
[object]

Unique identifier for this copy of the Consent Statement.

extension
[Boolean, String, CodeableConcept, Coding, HumanName, Reference]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

One of:
url
required, string

Source of the definition for the extension code - a logical name or a URL.

valueBoolean
boolean

A single value for the extension.

use
string

The purpose of this identifier.

Possible Values: usual, official, temp, secondary, old (If known)
system
string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

value
string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

patient
object

The patient/healthcare consumer to whom this consent applies.

Must be a resource of type Patient.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

organization
[object]

The custodian organization(s) that manage the consent, and the framework within which it is executed.

Must be a resource of type Organization.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

verification
[object]

Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.

verified
required, boolean

Has the instruction been verified.

verifiedWith
object

Who verified the instruction (Patient, Relative or other Authorized Person).

Must be a resource of type RelatedPerson.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

verificationDate
string

Date verification was collected.

provision
object

An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

period
object

The timeframe in this rule is valid.

start
string

The start of the period. The boundary is inclusive.

end
string

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

code
[object]

If this code is found in an instance, then the rule applies.

coding
[object]

A reference to a code defined by a terminology system.

system
string

The identification of the code system that defines the meaning of the symbol in the code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

sourceAttachment
object

The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.

url
string

A location where the data can be accessed.

search
required, object

Information about the search process that lead to the creation of this entry.

mode
required, string

Identifies the Consent as matching the search parameters

Value: match
Open dropdown

When not sending _include, only a Consent resource is returned