Jump to

• Request
• Response
• Examples

Retrieve Consent for Patients

get

/ohfapi/cg/v3.3/patientapi/consents

This endpoint supports the retrieval of Consents for multiple Patient Record (row) ids passed. It returns Consent related information like Status, Type and other associated information.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• id: array
  Collection Format: multi

  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  Patient Identifiers

  • [0]: integer(int64)

  {
      "name":"id",
      "in":"query",
      "description":"Patient Identifiers",
      "required":true,
      "type":"array",
      "items":{
          "type":"integer",
          "format":"int64"
      },
      "collectionFormat":"multi",
      "maxItems":2147483647,
      "minItems":1
  }

• limit(optional): integer(int32)
  Pagination query params: ?limit=2&offset=0
• offset(optional): integer(int32)
  Pagination query params: ?limit=2&offset=0

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : PageableCollectionConsent

Type: object

Model for paginated collections of data.

Show Source

• count(optional): integer(int64)
  Number of objects in the 'items' collection.
• hasMore(optional): boolean
  A boolean indicating if more pages are available.
• items(optional): array items
  A collection of paged items.
• links(optional): array links
  A collection of links containing hrefs to the current, next, and previous pages as applicable.
• resourceType(optional): string
  Identify the resource type

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"Identify the resource type"
        },
        "items":{
            "type":"array",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of paged items.",
            "items":{
                "$ref":"#/definitions/Consent"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "description":"Number of objects in the 'items' collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean indicating if more pages are available."
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for paginated collections of data."
}

Nested Schema : items

Type: array

A collection of paged items.

Show Source

• Array of: object Consent
  Model for a Consent object in CDM.

{
    "type":"array",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of paged items.",
    "items":{
        "$ref":"#/definitions/Consent"
    }
}

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Show Source

• Array of: string

{
    "type":"array",
    "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
    "items":{
        "type":"string"
    }
}

Example:

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Nested Schema : Consent

Type: object

Model for a Consent object in CDM.

Show Source

• code(optional): object CodeableConcept
  Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
• consentStatus(optional): object ConsentStatus
• consentType(optional): object ConsentType
• identifier(optional): object CdmIdentifier
  Identifier assigned by a given system
• patient(optional): object LinkedReference
• period(optional): object DateRange
• subject(optional): object LinkedReference

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"Identifier information for this record.",
            "$ref":"#/definitions/CdmIdentifier"
        },
        "code":{
            "description":"Consent Code",
            "$ref":"#/definitions/CodeableConcept"
        },
        "period":{
            "description":"The start and end date and time of the consent",
            "$ref":"#/definitions/DateRange"
        },
        "subject":{
            "description":"reference link to the subject",
            "$ref":"#/definitions/LinkedReference"
        },
        "patient":{
            "description":"reference link to the patient",
            "$ref":"#/definitions/LinkedReference"
        },
        "consentStatus":{
            "description":"The status of the consent",
            "$ref":"#/definitions/ConsentStatus"
        },
        "consentType":{
            "description":"The consent type",
            "$ref":"#/definitions/ConsentType"
        }
    },
    "description":"Model for a Consent object in CDM."
}

Nested Schema : CodeableConcept

Type: object

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

Show Source

• coding(optional): array coding
  Read Only: true

  Code(s) defined by a terminology system.
• text(optional): string
  Plain text representation of the concept.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"Plain text representation of the concept."
        },
        "coding":{
            "type":"array",
            "description":"Code(s) defined by a terminology system.",
            "readOnly":true,
            "items":{
                "xml":{
                    "name":"coding"
                },
                "$ref":"#/definitions/Coding"
            }
        }
    },
    "description":"Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text."
}

Nested Schema : ConsentStatus

Type: object

Show Source

• identifier(optional): object CdmIdentifier
  Identifier assigned by a given system
• status(optional): object CodeableConcept
  Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

{
    "type":"object",
    "properties":{
        "identifier":{
            "$ref":"#/definitions/CdmIdentifier"
        },
        "status":{
            "description":"The consent status details - status code, name , description etc.",
            "$ref":"#/definitions/CodeableConcept"
        }
    }
}

Nested Schema : ConsentType

Type: object

Show Source

• identifier(optional): object CdmIdentifier
  Identifier assigned by a given system
• type(optional): object CodeableConcept
  Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

{
    "type":"object",
    "properties":{
        "identifier":{
            "$ref":"#/definitions/CdmIdentifier"
        },
        "type":{
            "description":"The consent type details - such as consent type code, name , description etc.",
            "$ref":"#/definitions/CodeableConcept"
        }
    }
}

Nested Schema : CdmIdentifier

Type: object

Identifier assigned by a given system

Show Source

• system(optional): string
  System which assigned this identifier
• value(optional): string
  Identifier value

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"System which assigned this identifier"
        },
        "value":{
            "type":"string",
            "description":"Identifier value"
        }
    },
    "description":"Identifier assigned by a given system"
}

Nested Schema : LinkedReference

Type: object

Show Source

• display(optional): string
• reference(optional): string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : DateRange

Type: object

Show Source

• end(optional): string(date-time)
• start(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : coding

Type: array

Read Only: true

Code(s) defined by a terminology system.

Show Source

• Array of: object Coding
  Model for a reference to a code defined by a terminology system.

{
    "type":"array",
    "description":"Code(s) defined by a terminology system.",
    "readOnly":true,
    "items":{
        "xml":{
            "name":"coding"
        },
        "$ref":"#/definitions/Coding"
    }
}

Nested Schema : Coding

Type: object

Model for a reference to a code defined by a terminology system.

Show Source

• code(optional): string
  Symbol in syntax defined by the system.
• description(optional): string
  Description defined by the system.
• display(optional): string
  Representation defined by the system.
• srvcProviderId(optional): string
  Service Provider Id of Specimen Alias .
• srvcProviderName(optional): string
  Service Provider Name of Specimen Alias .
• sysId(optional): string
  Identity of the terminology system.
• sysName(optional): string
  Name of the terminology system.
• sysVersion(optional): string
  Version of the system - if relevant.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Symbol in syntax defined by the system."
        },
        "display":{
            "type":"string",
            "description":"Representation defined by the system."
        },
        "description":{
            "type":"string",
            "description":"Description defined by the system."
        },
        "sysId":{
            "type":"string",
            "description":"Identity of the terminology system."
        },
        "sysName":{
            "type":"string",
            "description":"Name of the terminology system."
        },
        "sysVersion":{
            "type":"string",
            "description":"Version of the system - if relevant."
        },
        "srvcProviderId":{
            "type":"string",
            "description":"Service Provider Id of Specimen Alias ."
        },
        "srvcProviderName":{
            "type":"string",
            "description":"Service Provider Name of Specimen Alias ."
        }
    },
    "description":"Model for a reference to a code defined by a terminology system."
}

400 Response

Invalid parameters supplied

404 Response

consents not found

Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/patientapi/consents?id=1&id=2&limit=2&offset=0

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "resourceType": "Consent",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "1"
      },
      "period": {
        "start": "11/14/1998",
        "end": "12/31/1998"
      },
      "patient": {
        "reference": "/ohfapi/cg/v3.3/patientapi/patients/1"
      },
      "consentStatus": {
        "identifier": {
          "system": "CDM",
          "value": "2"
        },
        "status": {
          "coding": [
            {
              "code": "2",
              "display": "Withdrawn",
              "description": "Consent Status Description",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "consentType": {
        "identifier": {
          "system": "CDM",
          "value": "1"
        },
        "type": {
          "coding": [
            {
              "code": "CS1",
              "display": "CS1Name",
              "description": "Consent Description",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "2"
      },
      "period": {
        "start": "11/14/1998",
        "end": "12/31/1998"
      },
      "patient": {
        "reference": "/ohfapi/cg/v3.3/patientapi/patients/1"
      },
      "consentStatus": {
        "identifier": {
          "system": "CDM",
          "value": "2"
        },
        "status": {
          "coding": [
            {
              "code": "2",
              "display": "Withdrawn",
              "description": "Consent Status Description",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "consentType": {
        "identifier": {
          "system": "CDM",
          "value": "1"
        },
        "type": {
          "coding": [
            {
              "code": "CS1",
              "display": "CS1Name",
              "description": "Consent Description",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      }
    }
  ],
  "count": 2,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/consents?id=1&id=2&limit=2&offset=0"
    },
    {
      "rel": "next",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/consents?offset=2&limit=2&id=1&id=2"
    }
  ]
}

Back to Top