REST Capabilities Server
Mode | Server |
Resource Interactions
Resource Type | Profile | Supported Profiles | Read | SearchType |
---|---|---|---|---|
Location | Location | SHALL | SHALL | |
DocumentReference | DocumentReference | SHALL | SHALL | |
EvidenceVariable | EvidenceVariable | SHALL | SHALL | |
Group | Group | SHALL | SHALL | |
Organization | Organization | SHALL | SHALL | |
PractitionerRole | PractitionerRole | SHALL | SHALL | |
Practitioner | Practitioner | SHALL | SHALL | |
Provenance | Provenance | SHALL | SHALL | |
Questionnaire | Questionnaire | SHALL | SHALL | |
ResearchStudy | ResearchStudy | SHALL | SHALL |
Search Parameters per resource type
Location
No search parameters are stated for this resource type
DocumentReference
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | Master Version Specific Identifier | SHALL |
masteridentifier | token | Master Version Specific Identifier | SHALL |
description | string | Human-readable description | SHALL |
format | token | Format/content rules for the document | SHALL |
language | token | Human language of the content BCP-47 | SHALL |
EvidenceVariable
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | External identifier for the evidence variable | SHALL |
title | string | The human-friendly name of the evidence variable | SHALL |
description | string | The description of the evidence variable | SHALL |
Group
Name | Type | Documentation | Level |
---|---|---|---|
actual | token | Descriptive or actual | SHALL |
characteristic | token | Kind of characteristic | SHALL |
value | token | Value held by characteristic | SHALL |
Organization
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | Any identifier for the organization - not the accreditation issuer's identifier | SHALL |
name | string | A portion of the organization's name or alias | SHALL |
address | string | A server defined search that may match any of the string fields in the Address - including line/ city/ district/ state/ country/ postalCode/ and/or text | SHALL |
partOf | reference | An organization of which this organization forms a part | SHALL |
PractitionerRole
Name | Type | Documentation | Level |
---|---|---|---|
practitioner | reference | Practitioner that is able to provide the defined services for the organization | SHALL |
organization | reference | The identity of the organization the practitioner represents / acts on behalf of | SHALL |
phone | token | A value in a phone contact | SHALL |
Practitioner
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | A practitioner's Identifier | SHALL |
name | string | A server defined search that may match any of the string fields in the HumanName - including family/ give/ prefix/ suffix/ suffix/ and/or text | SHALL |
given | string | A portion of the given name | SHALL |
family | string | A portion of the family name | SHALL |
Provenance
Name | Type | Documentation | Level |
---|---|---|---|
agent | reference | Who participated | SHALL |
target | reference | Target References usually version specific | SHALL |
recorded | date | When the activity was recorded / updated | SHALL |
Questionnaire
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | External identifier for the questionnaire | SHALL |
title | string | The human-friendly name of the questionnaire | SHALL |
version | token | The business version of the questionnaire | SHALL |
status | token | The current status of the questionnaire | SHALL |
description | string | The description of the questionnaire | SHALL |
ResearchStudy
Name | Type | Documentation | Level |
---|---|---|---|
category | token | Classifications for the study | SHALL |
date | date | When the study began and ended | SHALL |
focus | token | Drugs/devices/etc under study | SHALL |
identifier | token | Business Identifier for study | SHALL |
keyword | token | Used to search for the study | SHALL |
location | token | Geographic regions for study | SHALL |
site | reference | Facility where study activities are conducted | SHALL |
title | string | Name for this study | SHALL |