Home
API reference
FHIR® API
FHIR® resources
Consent
_search

Consent _search

post/Consent/_search
Page View

This resource contains the legally binding requirements for any type of healthcare consent. Patient consent may be related to privacy, medical treatment, research, or advance care (e.g., DNR).

You can review or retrieve consent information.

_search

Query for a patient’s consent details, as documented by one provider.

This is a flexible option with query parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Consent/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string' \
7
--data-urlencode 'scope=string' \
8
--data-urlencode 'category=string' \
9
--data-urlencode 'organization=string' \
10
--data-urlencode 'verifiedWith=string'

Request Body Schema

  • patient
    Array of string

    The patient to whom the consent applies

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • scope
    Array of string

    Which of the areas this consent covers

  • category
    Array of string

    The category of the consent

  • organization
    Array of string

    The custodian organization that manages the consent

  • verifiedWith
    Array of string

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

Response fields and example

json
1
{}

    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
    Array of Consent, Organization, RelatedPerson or Other

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

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

        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
          Array of 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, Array of object

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

        • coding
          Array of 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
          Array of 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
        Array of object

        Unique identifier for this copy of the Consent Statement.

        • extension
          Array of Boolean, String, CodeableConcept, Coding, HumanName or 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.

          • 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
        Array of 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
        Array of 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
          Array of object

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

          • coding
            Array of 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