ResearchStudy - FHIR Resource (stu3)


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

Resource Attributes

AttributeField is listTypeDescription
armtrueData Type Defined path through the study for a subject
categorytrueCodeableConcept Classifications for the study
contacttrueContactDetail Contact details for the study
descriptionfalsemarkdown What this is study doing
enrollmenttrueReference Inclusion & exclusion criteria
focustrueCodeableConcept Drugs, devices, conditions, etc. under study
identifiertrueIdentifier Business Identifier for study
jurisdictiontrueCodeableConcept Geographic region(s) for study
keywordtrueCodeableConcept Used to search for the study
notetrueAnnotation Comments made about the event
partOftrueReference Part of larger study
periodfalsePeriod When the study began and ended
principalInvestigatorfalseReference The individual responsible for the study
protocoltrueReference Steps followed in executing study
reasonStoppedfalseCodeableConcept Reason for terminating study early
relatedArtifacttrueRelatedArtifact References and dependencies
sitetrueReference Location involved in study execution
sponsorfalseReference Organization responsible for the study
statusfalsecode draft | in-progress | suspended | stopped | completed | entered-in-error
titlefalsestring 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 ParameterField TypeResource Fields Searched
categorytextcategory
datedateperiod
focustextfocus
identifiertextidentifier
jurisdictiontextjurisdiction
keywordtextkeyword
partofreferencepartOf
principalinvestigatorreferenceprincipalInvestigator
protocolreferenceprotocol
sitereferencesite
sponsorreferencesponsor
statustextstatus
titletexttitle