Retrieve Consent for a Subject Identifier
get
/ohfapi/cg/v3.3/subjectapi/subjects/{id}/consent
This endpoint supports the retrieval of Consents for a single Subject Identifier passed. It returns all the Consents related information like Status, Type and other associated information.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Minimum Value:
0
Subject Row ID
Query Parameters
-
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
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
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
Nested Schema : items
Type:
array
A collection of paged items.
Show Source
-
Array of:
object Consent
Model for a Consent object in CDM.
Nested Schema : links
Type:
array
A collection of links containing hrefs to the current, next, and previous pages as applicable.
Show Source
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
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.
Nested Schema : ConsentStatus
Type:
Show Source
object
-
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.
Nested Schema : ConsentType
Type:
Show Source
object
-
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.
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
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.
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.
400 Response
Invalid parameters supplied
404 Response
consent not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects/1/consent?limit=2&offset=0
Example of Response Body
The following example shows the response returned in JSON format.
{ "resourceType": "Consent", "items": [ { "identifier": { "system": "CDM", "value": "1" }, "period": { "start": "11/14/1998", "end": "12/31/1998" }, "subject": { "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1" }, "patient": { "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1/patients" }, "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" }, "subject": { "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1" }, "patient": { "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1/patients" }, "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/subjectapi/subjects/1/consent?limit=2&offset=0" }, { "rel": "next", "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects/1/consent?offset=2&limit=2" } ] }