ResearchDefinition - FHIR Resource (r4)


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

Validate an ResearchDefinition FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
approvalDatefalsedate# When the research definition was approved by publisher
authortrueContactDetail# Who authored the content
commenttruestring# Used for footnotes or explanatory notes
contacttrueContactDetail# Contact details for the publisher
copyrightfalsemarkdown# Use and/or publishing restrictions
datefalsedateTime# Date last changed
descriptionfalsemarkdown# Natural language description of the research definition
editortrueContactDetail# Who edited the content
effectivePeriodfalsePeriod# When the research definition is expected to be used
endorsertrueContactDetail# Who endorsed the content
experimentalfalseboolean# For testing purposes, not real usage
exposurefalseReference# What exposure?
exposureAlternativefalseReference# What alternative exposure state?
identifiertrueIdentifier# Additional identifier for the research definition
jurisdictiontrueCodeableConcept# Intended jurisdiction for research definition (if applicable)
lastReviewDatefalsedate# When the research definition was last reviewed
librarytruecanonical(Library)# Logic used by the ResearchDefinition
namefalsestring# C? Name for this research definition (computer friendly)
outcomefalseReference# What outcome?
populationfalseReference# What population?
publisherfalsestring# Name of the publisher (organization or individual)
purposefalsemarkdown# Why this research definition is defined
relatedArtifacttrueRelatedArtifact# Additional documentation, citations, etc.
reviewertrueContactDetail# Who reviewed the content
shortTitlefalsestring# Title for use in informal contexts
statusfalsecode# draft | active | retired | unknown
subject[x]falseReference#undefined
subtitlefalsestring# Subordinate title of the ResearchDefinition
titlefalsestring# Name for this research definition (human friendly)
topictrueCodeableConcept# The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
urlfalseuri# Canonical identifier for this research definition, represented as a URI (globally unique)
usagefalsestring# Describes the clinical usage of the ResearchDefinition
useContexttrueUsageContext# The context that the content is intended to support
versionfalsestring# Business version of the research definition

ResearchDefinition Example

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

ResearchDefinition Structure

{
  "resourceType" : "ResearchDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this research definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the research definition
  "version" : "<string>", // Business version of the research definition
  "name" : "<string>", // C? Name for this research definition (computer friendly)
  "title" : "<string>", // Name for this research definition (human friendly)
  "shortTitle" : "<string>", // Title for use in informal contexts
  "subtitle" : "<string>", // Subordinate title of the ResearchDefinition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the research definition
  "comment" : ["<string>"], // Used for footnotes or explanatory notes
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for research definition (if applicable)
  "purpose" : "<markdown>", // Why this research definition is defined
  "usage" : "<string>", // Describes the clinical usage of the ResearchDefinition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the research definition was approved by publisher
  "lastReviewDate" : "<date>", // When the research definition was last reviewed
  "effectivePeriod" : { Period }, // When the research definition is expected to be used
  "topic" : [{ CodeableConcept }], // The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "library" : [{ canonical(Library) }], // Logic used by the ResearchDefinition
  "population" : { Reference(ResearchElementDefinition) }, // R!  What population?
  "exposure" : { Reference(ResearchElementDefinition) }, // What exposure?
  "exposureAlternative" : { Reference(ResearchElementDefinition) }, // What alternative exposure state?
  "outcome" : { Reference(ResearchElementDefinition) } // What outcome?
}

ResearchDefinition Search Parameters

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

https://api.1up.health/fhir/r4/ResearchDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
composed-ofreferencerelatedArtifact.where
contexttextuseContext.value
context-quantityquantityuseContext.value
context-typetextuseContext.code
context-type-quantitycompositeuseContext
context-type-valuecompositeuseContext
datedatedate
depends-onreferencerelatedArtifact.where
derived-fromreferencerelatedArtifact.where
descriptiontextdescription
effectivedateeffectivePeriod
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
predecessorreferencerelatedArtifact.where
publishertextpublisher
statustextstatus
successorreferencerelatedArtifact.where
titletexttitle
topictexttopic
urluriurl
versiontextversion