ResearchStudy - FHIR Resource (r4)
This ResearchStudy Resource uses the FHIR API standard for access and structure.
Validate an ResearchStudy FHIR Resource (r4)
ResearchStudy Attributes
AttributeField is listTypeDescription
Description: Business Identifier for study
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (ResearchStudy) identifier FHIR attribute
Description: Name for this study
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": Learn more about the (ResearchStudy) title FHIR attribute
Description: Steps followed in executing study
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"protocol": Learn more about the (ResearchStudy) protocol FHIR attribute
Description: Part of larger study
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partOf": Learn more about the (ResearchStudy) partOf FHIR attribute
Description: 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
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "completed"Learn more about the (ResearchStudy) status FHIR attribute
Description: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"primaryPurposeType": Learn more about the (ResearchStudy) primaryPurposeType FHIR attribute
Description: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"phase": Learn more about the (ResearchStudy) phase FHIR attribute
Description: Classifications for the study
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": Learn more about the (ResearchStudy) category FHIR attribute
Description: Drugs, devices, etc. under study
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"focus": Learn more about the (ResearchStudy) focus FHIR attribute
Description: Condition being studied
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"condition": Learn more about the (ResearchStudy) condition FHIR attribute
Description: Contact details for the study
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (ResearchStudy) contact FHIR attribute
Description: References and dependencies
FHIR Version: r4
Attribute Type : RelatedArtifact
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relatedArtifact": Learn more about the (ResearchStudy) relatedArtifact FHIR attribute
Description: Used to search for the study
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"keyword": Learn more about the (ResearchStudy) keyword FHIR attribute
Description: Geographic region(s) for study
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": Learn more about the (ResearchStudy) location FHIR attribute
Description: What this is study doing
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (ResearchStudy) description FHIR attribute
Description: Inclusion & exclusion criteria
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"enrollment": Learn more about the (ResearchStudy) enrollment FHIR attribute
Description: When the study began and ended
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": Learn more about the (ResearchStudy) period FHIR attribute
Description: Organization that initiates and is legally responsible for the study
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sponsor": Learn more about the (ResearchStudy) sponsor FHIR attribute
Description: Researcher who oversees multiple aspects of the study
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"principalInvestigator": Learn more about the (ResearchStudy) principalInvestigator FHIR attribute
Description: Facility where study activities are conducted
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"site": Learn more about the (ResearchStudy) site FHIR attribute
Description: accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonStopped": Learn more about the (ResearchStudy) reasonStopped FHIR attribute
Description: Comments made about the study
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (ResearchStudy) note FHIR attribute
Description: Defined path through the study for a subject
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"arm": Learn more about the (ResearchStudy) arm FHIR attribute
Description: A goal for the study
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"objective": Learn more about the (ResearchStudy) objective FHIR attribute
ResearchStudy Example
{
"resourceType": "ResearchStudy",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>"
},
"status": "completed"
}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! 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
"primaryPurposeType" : { CodeableConcept }, // treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
"phase" : { CodeableConcept }, // n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
"category" : [{ CodeableConcept }], // Classifications for the study
"focus" : [{ CodeableConcept }], // Drugs, devices, etc. under study
"condition" : [{ CodeableConcept }], // Condition being studied
"contact" : [{ ContactDetail }], // Contact details for the study
"relatedArtifact" : [{ RelatedArtifact }], // References and dependencies
"keyword" : [{ CodeableConcept }], // Used to search for the study
"location" : [{ 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 that initiates and is legally responsible for the study
"principalInvestigator" : { Reference(Practitioner|PractitionerRole) }, // Researcher who oversees multiple aspects of the study
"site" : [{ Reference(Location) }], // Facility where study activities are conducted
"reasonStopped" : { CodeableConcept }, // accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
"note" : [{ Annotation }], // Comments made about the study
"arm" : [{ // Defined path through the study for a subject
"name" : "<string>", // R! Label for study arm
"type" : { CodeableConcept }, // Categorization of study arm
"description" : "<string>" // Short explanation of study path
}],
"objective" : [{ // A goal for the study
"name" : "<string>", // Label for the objective
"type" : { CodeableConcept } // primary | secondary | exploratory
}]
}
ResearchStudy Search Parameters
The following search parameters can be used to query ResearchStudy resources. Just submit them like so:
https://api.1up.health/fhir/r4/ResearchStudy?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
category | text | category |
date | date | period |
focus | text | focus |
identifier | text | identifier |
keyword | text | keyword |
location | text | location |
partof | reference | partOf |
principalinvestigator | reference | principalInvestigator |
protocol | reference | protocol |
site | reference | site |
sponsor | reference | sponsor |
status | text | status |
title | text | title |
