Skip to main content

ResearchDefinition

Draft Other

The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/ResearchDefinition
InteractionMethodPath
ReadGET/fhir/R4/ResearchDefinition/[id]
VreadGET/fhir/R4/ResearchDefinition/[id]/_history/[vid]
UpdatePUT/fhir/R4/ResearchDefinition/[id]
PatchPATCH/fhir/R4/ResearchDefinition/[id]
DeleteDELETE/fhir/R4/ResearchDefinition/[id]
CreatePOST/fhir/R4/ResearchDefinition
SearchGET/fhir/R4/ResearchDefinition
HistoryGET/fhir/R4/ResearchDefinition/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
urluri0..1Canonical identifier for this research definition, represented as a URI (globally unique)
identifierIdentifier0..*Additional identifier for the research definition
versionstring0..1Business version of the research definition
namestring0..1Name for this research definition (computer friendly)
titlestring0..1Name for this research definition (human friendly)
shortTitlestring0..1Title for use in informal contexts
subtitlestring0..1Subordinate title of the ResearchDefinition
statuscode1..1draft | active | retired | unknown modifier
experimentalboolean0..1For testing purposes, not real usage
subject[x]CodeableConcept / Reference0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
datedateTime0..1Date last changed
publisherstring0..1Name of the publisher (organization or individual)
contactContactDetail0..*Contact details for the publisher
descriptionmarkdown0..1Natural language description of the research definition
commentstring0..*Used for footnotes or explanatory notes
useContextUsageContext0..*The context that the content is intended to support
jurisdictionCodeableConcept0..*Intended jurisdiction for research definition (if applicable)
purposemarkdown0..1Why this research definition is defined
usagestring0..1Describes the clinical usage of the ResearchDefinition
copyrightmarkdown0..1Use and/or publishing restrictions
approvalDatedate0..1When the research definition was approved by publisher
lastReviewDatedate0..1When the research definition was last reviewed
effectivePeriodPeriod0..1When the research definition is expected to be used
topicCodeableConcept0..*The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
authorContactDetail0..*Who authored the content
editorContactDetail0..*Who edited the content
reviewerContactDetail0..*Who reviewed the content
endorserContactDetail0..*Who endorsed the content
relatedArtifactRelatedArtifact0..*Additional documentation, citations, etc.
librarycanonical0..*Logic used by the ResearchDefinition
populationReference1..1What population?
exposureReference0..1What exposure?
exposureAlternativeReference0..1What alternative exposure state?
outcomeReference0..1What outcome?

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
composed-ofstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-composed-of
contextstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-context
context-quantitystringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-context-quantity
context-typestringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-context-type
context-type-quantitystringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-context-type-quantity
context-type-valuestringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-context-type-value
datestringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-date
depends-onstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-depends-on
derived-fromstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-derived-from
descriptionstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-description
effectivestringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-effective
identifierstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-identifier
jurisdictionstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-jurisdiction
namestringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-name
predecessorstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-predecessor
publisherstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-publisher
statusstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-status
successorstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-successor
titlestringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-title
topicstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-topic
urlstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-url
versionstringhttp://hl7.org/fhir/SearchParameter/ResearchDefinition-version

Reference​