ResearchStudy

See FHIR specification

This resource type represents the “projects” on MIDATA. For each project on MIDATA that has been validated or is currently validated there is exactly one ResearchStudy resource describing the project. These generated ResearchStudy resources are read-only. The resource type may also be used for storing ResearchStudy resources describing external studies not related to MIDATA.

Hybrid use

This FHIR resource may be used in two different ways on the MIDATA platform. It may be used as a “normal” FHIR resource in order to store data or it may be used as part of built-in functionality of the platform. In the later case each instance of the resource corresponds to an entity of the platform.

Semantical type

The semantical type is “ExternalResearchStudy” if the resource is used for data storage without additional platform logic. Otherwise the semantical type is “ResearchStudy”.

If you need access to this FHIR resource you need to add either one or both of the content types to the access filter.

If an instance of the ResearchStudy FHIR resource is treated as normal FHIR resource or with MIDATA platform logic is based on the resource content.

If a ResearchStudy resource contains an identifier with the codesystem “http://midata.coop/codesystems/project-code”, it will be treated as a ResearchStudy resource belonging to a MIDATA project:

{
  "resourceType" : "ResearchStudy",
  "identifier" : [
      {
         "system": "http://midata.coop/codesystems/project-code",
         "code": ...
         "display": ...
      }
  ]  
}

For backwards compatibility to older versions of the platform, also if the codesystem “http://midata.coop/codesystems/study-code” is used, the resource is treated as MIDATA project.

Resource owner

The creator of the resource is always the owner of the resource.

Public resource

This resource is used as a public resource without access restrictions.

However, it is important that you specify in the access filter of your application that you want to use this public resource.

Example resource

Here is an example ResearchStudy

{
	"resourceType": "ResearchStudy",
	"id" : "59e0a95279c7214020b9694d",
	"meta": {
		"security": [
			{
				"system": "http://midata.coop/codesystems/security",
				"code": "public"
			}
		]
	},
	"identifier": [
		{
			"system": "http://midata.coop/codesystems/project-code",
			"value": "RCOL-H2J1"
		}
	],
	"title": "Example Research",
	"status": "active",
	"description": "This is a demonstration study.",
	"sponsor": {
		"reference": "Organization/56eab03479c7210af1ae8df0",
		"display": "Big Research"
	},
	"arm": [
		{
			"name": "Test",
			"description": "For testing purposes"
		},
		{
			"name": "Main",
			"description": "Real participants"
		}
	]
}

Read

Read a single ResearchStudy by id.

Request:

[GET] /fhir/ResearchStudy/<id>

Read specific version

Read a specific version of a single ResearchStudy by id.

Request:

[GET] /fhir/ResearchStudy/<id>/_history/<version>

Retrieve history

Retrieve all versions of a single resource.

Request:

[GET] /fhir/ResearchStudy/<id>/_history

Search

Search for resources of type ResearchStudy

Request:

[GET] /fhir/ResearchStudy?searchParams

List of supported search parameters:

Supported query parameters:

Name	Type	Description
_id	string	The resource identity
_lastUpdated	date	Only return resources which were last updated as specified by the given range
_page	string
category	token	Classifications for the study
date	date	When the study began and ended
focus	token	Drugs, devices, etc. under study
identifier	token	Business Identifier for study
keyword	token	Used to search for the study
location	token	Geographic region(s) for study
partof	reference	Part of larger study
principalinvestigator	reference	Researcher who oversees multiple aspects of the study
protocol	reference	Steps followed in executing study
site	reference	Facility where study activities are conducted
sponsor	reference	Organization that initiates and is legally responsible for the study
status	token	active - administratively-completed - approved - closed-to-accrual - closed-to-accrual-and-intervention - completed - disapproved - in-review - temporarily-closed-to-accrual - temporarily-closed-to-accrual-and-intervention - withdrawn
title	string	Name for this study

Create

Create a new resource of type ResearchStudy.

Request:

[POST] /fhir/ResearchStudy

Update

Updates a resource of type ResearchStudy.

Request:

[PUT] /fhir/ResearchStudy/<id>