ResearchStudy - FHIR Resource (stu3)

This ResearchStudy Resource uses the FHIR API standard for access and structure.

Validate an ResearchStudy FHIR Resource (stu3)

Resource Attributes

Attribute	Field is list	Type	Description
arm	true	Data Type	Defined path through the study for a subject
category	true	CodeableConcept	Classifications for the study
contact	true	ContactDetail	Contact details for the study
description	false	markdown	What this is study doing
enrollment	true	Reference	Inclusion & exclusion criteria
focus	true	CodeableConcept	Drugs, devices, conditions, etc. under study
identifier	true	Identifier	Business Identifier for study
jurisdiction	true	CodeableConcept	Geographic region(s) for study
keyword	true	CodeableConcept	Used to search for the study
note	true	Annotation	Comments made about the event
partOf	true	Reference	Part of larger study
period	false	Period	When the study began and ended
principalInvestigator	false	Reference	The individual responsible for the study
protocol	true	Reference	Steps followed in executing study
reasonStopped	false	CodeableConcept	Reason for terminating study early
relatedArtifact	true	RelatedArtifact	References and dependencies
site	true	Reference	Location involved in study execution
sponsor	false	Reference	Organization responsible for the study
status	false	code	draft | in-progress | suspended | stopped | completed | entered-in-error
title	false	string	Name for this study

ResearchStudy Example

{
  "resourceType": "ResearchStudy",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>"
  },
  "status": "draft",
  "id": "example"
}

ResearchStudy Structure

  
{
  "resourceType" : "ResearchStudy",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for study
  "title" : "<string>", // Name for this study
  "protocol" : [{ Reference(PlanDefinition) }], // Steps followed in executing study
  "partOf" : [{ Reference(ResearchStudy) }], // Part of larger study
  "status" : "<code>", // R!  draft | in-progress | suspended | stopped | completed | entered-in-error
  "category" : [{ CodeableConcept }], // Classifications for the study
  "focus" : [{ CodeableConcept }], // Drugs, devices, conditions, etc. under study
  "contact" : [{ ContactDetail }], // Contact details for the study
  "relatedArtifact" : [{ RelatedArtifact }], // References and dependencies
  "keyword" : [{ CodeableConcept }], // Used to search for the study
  "jurisdiction" : [{ CodeableConcept }], // Geographic region(s) for study
  "description" : "<markdown>", // What this is study doing
  "enrollment" : [{ Reference(Group) }], // Inclusion & exclusion criteria
  "period" : { Period }, // When the study began and ended
  "sponsor" : { Reference(Organization) }, // Organization responsible for the study
  "principalInvestigator" : { Reference(Practitioner) }, // The individual responsible for the study
  "site" : [{ Reference(Location) }], // Location involved in study execution
  "reasonStopped" : { CodeableConcept }, // Reason for terminating study early
  "note" : [{ Annotation }], // Comments made about the event
  "arm" : [{ // Defined path through the study for a subject
    "name" : "<string>", // R!  Label for study arm
    "code" : { CodeableConcept }, // Categorization of study arm
    "description" : "<string>" // Short explanation of study path
  }]
}


 

ResearchStudy Search Parameters

The following search parameters can be used to query ResearchStudy resources. Just submit the like so:

https://api.1up.health/fhir/stu3/ResearchStudy?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
category	text	category
date	date	period
focus	text	focus
identifier	text	identifier
jurisdiction	text	jurisdiction
keyword	text	keyword
partof	reference	partOf
principalinvestigator	reference	principalInvestigator
protocol	reference	protocol
site	reference	site
sponsor	reference	sponsor
status	text	status
title	text	title