FHIR Release 3 (STU)
AdministrationThis page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
| Regulated Clinical Research Information Management Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Practitioner |
StructureDefinition for researchstudy
{
"resourceType": "StructureDefinition",
"id": "ResearchStudy",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "rcrim"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ResearchStudy",
"name": "ResearchStudy",
"status": "draft",
"date": "2019-10-24T11:53:00+11:00",
"publisher": "Health Level Seven International (Regulated Clinical Research Information Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ResearchStudy Resource",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "clinicaltrials-gov",
"uri": "http://clinicaltrials.gov",
"name": "ClinicalTrials.gov Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "ResearchStudy",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "ResearchStudy",
"path": "ResearchStudy",
"short": "Investigation to increase healthcare-related patient-independent knowledge",
"definition": "A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.",
"comment": "Need to make sure we encompass public health studies.",
"alias": [
"Clinical Trial",
"Study"
],
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": "Observation[classCode=CLNTRL, moodCode=EVN]"
},
{
"identity": "w5",
"map": "clinical.diagnostics"
}
]
},
{
"id": "ResearchStudy.id",
"path": "ResearchStudy.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "ResearchStudy.meta",
"path": "ResearchStudy.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "ResearchStudy.implicitRules",
"path": "ResearchStudy.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "ResearchStudy.language",
"path": "ResearchStudy.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "ResearchStudy.text",
"path": "ResearchStudy.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "ResearchStudy.contained",
"path": "ResearchStudy.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ResearchStudy.extension",
"path": "ResearchStudy.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ResearchStudy.modifierExtension",
"path": "ResearchStudy.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ResearchStudy.identifier",
"path": "ResearchStudy.identifier",
"short": "Business Identifier for study",
"definition": "Identifiers assigned to this research study by the sponsor or other systems.",
"requirements": "Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Organization's Unique Protocol ID; Secondary IDs"
},
{
"identity": "rim",
"map": ".identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ResearchStudy.title",
"path": "ResearchStudy.title",
"short": "Name for this study",
"definition": "A short, descriptive user-friendly label for the study.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Brief Title"
}
]
},
{
"id": "ResearchStudy.protocol",
"path": "ResearchStudy.protocol",
"short": "Steps followed in executing study",
"definition": "The set of steps expected to be performed as part of the execution of the study.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Interventions; Arm/Intervention Cross-Reference"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target"
}
]
},
{
"id": "ResearchStudy.partOf",
"path": "ResearchStudy.partOf",
"short": "Part of larger study",
"definition": "A larger research study of which this particular study is a component or step.",
"requirements": "Allows breaking a study into components (e.g. by study site) each with their own PI, status, enrollment, etc.",
"alias": [
"container"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ResearchStudy"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}
]
},
{
"id": "ResearchStudy.status",
"path": "ResearchStudy.status",
"short": "draft | in-progress | suspended | stopped | completed | entered-in-error",
"definition": "The current state of the study.",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResearchStudyStatus"
}
],
"strength": "required",
"description": "Codes that convey the current status of the research study",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/research-study-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "ResearchStudy.category",
"path": "ResearchStudy.category",
"short": "Classifications for the study",
"definition": "Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResearchStudyCategory"
}
],
"strength": "example",
"description": "Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc."
},
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Study Type; Primary Purpose; Study Phase; Interventional Model; Masking; Allocation; study Classification; Observational Study Model; Time Perspective; Biospecimen Retention"
}
]
},
{
"id": "ResearchStudy.focus",
"path": "ResearchStudy.focus",
"short": "Drugs, devices, conditions, etc. under study",
"definition": "The condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResearchStudyFocus"
}
],
"strength": "example",
"description": "Codes for medications, devices, conditions and other interventions"
},
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Conditions or Focus of Study"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "ResearchStudy.contact",
"path": "ResearchStudy.contact",
"short": "Contact details for the study",
"definition": "Contact details to assist a user in learning more about or engaging with the study.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Central Contact; Central Contact Backup; Overall Study Officials; Facility Contact & Backup (if Study tied to only one location); Investigators"
}
]
},
{
"id": "ResearchStudy.relatedArtifact",
"path": "ResearchStudy.relatedArtifact",
"short": "References and dependencies",
"definition": "Citations, references and other related documents.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedArtifact"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Citations, Links, Available Study Data/Documents"
}
]
},
{
"id": "ResearchStudy.keyword",
"path": "ResearchStudy.keyword",
"short": "Used to search for the study",
"definition": "Key terms to aid in searching for or filtering the study.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResearchStudyKeyword"
}
],
"strength": "example",
"description": "Words associated with the study that may be useful in discovery"
},
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Keywords"
}
]
},
{
"id": "ResearchStudy.jurisdiction",
"path": "ResearchStudy.jurisdiction",
"short": "Geographic region(s) for study",
"definition": "Indicates a country, state or other region where the study is taking place.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "ResearchStudy.description",
"path": "ResearchStudy.description",
"short": "What this is study doing",
"definition": "A full description of how the study is being conducted.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Detailed Description"
}
]
},
{
"id": "ResearchStudy.enrollment",
"path": "ResearchStudy.enrollment",
"short": "Inclusion & exclusion criteria",
"definition": "Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. \" 200 female Europeans between the ages of 20 and 45 with early onset diabetes\".",
"comment": "The Group referenced should not generally enumerate specific subjects. Subjects will be linked to the study using the ResearchSubject resource.",
"alias": [
"patient"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Enrollment; Number of Groups/Cohorts (= number of \"enrollment\" instances); Groups (Group/Cohort Label = Group.name; Group/Cohort Description = Group.description); Eligibility (Group criteria)"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "ResearchStudy.period",
"path": "ResearchStudy.period",
"short": "When the study began and ended",
"definition": "Identifies the start date and the expected (or actual, depending on status) end date for the study.",
"requirements": "[The list of types may be constrained as appropriate for the type of event].",
"alias": [
"timing"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Study Start Date (start); Study Completion Date (end)"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "ResearchStudy.sponsor",
"path": "ResearchStudy.sponsor",
"short": "Organization responsible for the study",
"definition": "The organization responsible for the execution of the study.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Sponsor"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "ResearchStudy.principalInvestigator",
"path": "ResearchStudy.principalInvestigator",
"short": "The individual responsible for the study",
"definition": "Indicates the individual who has primary oversite of the execution of the study.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Principal Investigator"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "ResearchStudy.site",
"path": "ResearchStudy.site",
"short": "Location involved in study execution",
"definition": "Clinic, hospital or other healthcare location that is participating in the study.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Facility"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "ResearchStudy.reasonStopped",
"path": "ResearchStudy.reasonStopped",
"short": "Reason for terminating study early",
"definition": "A description and/or code explaining the premature termination of the study.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Why Study Stopped"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "ResearchStudy.note",
"path": "ResearchStudy.note",
"short": "Comments made about the event",
"definition": "Comments made about the event by the performer, subject or other participants.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
]
},
{
"id": "ResearchStudy.arm",
"path": "ResearchStudy.arm",
"short": "Defined path through the study for a subject",
"definition": "Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Arms"
}
]
},
{
"id": "ResearchStudy.arm.id",
"path": "ResearchStudy.arm.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ResearchStudy.arm.extension",
"path": "ResearchStudy.arm.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ResearchStudy.arm.modifierExtension",
"path": "ResearchStudy.arm.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ResearchStudy.arm.name",
"path": "ResearchStudy.arm.name",
"short": "Label for study arm",
"definition": "Unique, human-readable label for this arm of the study.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Arm Label"
}
]
},
{
"id": "ResearchStudy.arm.code",
"path": "ResearchStudy.arm.code",
"short": "Categorization of study arm",
"definition": "Categorization of study arm, e.g. experimental, active comparator, placebo comparater.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Arm Type"
}
]
},
{
"id": "ResearchStudy.arm.description",
"path": "ResearchStudy.arm.description",
"short": "Short explanation of study path",
"definition": "A succinct description of the path through the study that would be followed by a subject adhering to this arm.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Arm Description"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ResearchStudy",
"path": "ResearchStudy",
"short": "Investigation to increase healthcare-related patient-independent knowledge",
"definition": "A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.",
"comment": "Need to make sure we encompass public health studies.",
"alias": [
"Clinical Trial",
"Study"
],
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": "Observation[classCode=CLNTRL, moodCode=EVN]"
},
{
"identity": "w5",
"map": "clinical.diagnostics"
}
]
},
{
"id": "ResearchStudy.identifier",
"path": "ResearchStudy.identifier",
"short": "Business Identifier for study",
"definition": "Identifiers assigned to this research study by the sponsor or other systems.",
"requirements": "Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Organization's Unique Protocol ID; Secondary IDs"
},
{
"identity": "rim",
"map": ".identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ResearchStudy.title",
"path": "ResearchStudy.title",
"short": "Name for this study",
"definition": "A short, descriptive user-friendly label for the study.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Brief Title"
}
]
},
{
"id": "ResearchStudy.protocol",
"path": "ResearchStudy.protocol",
"short": "Steps followed in executing study",
"definition": "The set of steps expected to be performed as part of the execution of the study.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Interventions; Arm/Intervention Cross-Reference"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target"
}
]
},
{
"id": "ResearchStudy.partOf",
"path": "ResearchStudy.partOf",
"short": "Part of larger study",
"definition": "A larger research study of which this particular study is a component or step.",
"requirements": "Allows breaking a study into components (e.g. by study site) each with their own PI, status, enrollment, etc.",
"alias": [
"container"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ResearchStudy"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}
]
},
{
"id": "ResearchStudy.status",
"path": "ResearchStudy.status",
"short": "draft | in-progress | suspended | stopped | completed | entered-in-error",
"definition": "The current state of the study.",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResearchStudyStatus"
}
],
"strength": "required",
"description": "Codes that convey the current status of the research study",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/research-study-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "ResearchStudy.category",
"path": "ResearchStudy.category",
"short": "Classifications for the study",
"definition": "Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResearchStudyCategory"
}
],
"strength": "example",
"description": "Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc."
},
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Study Type; Primary Purpose; Study Phase; Interventional Model; Masking; Allocation; study Classification; Observational Study Model; Time Perspective; Biospecimen Retention"
}
]
},
{
"id": "ResearchStudy.focus",
"path": "ResearchStudy.focus",
"short": "Drugs, devices, conditions, etc. under study",
"definition": "The condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResearchStudyFocus"
}
],
"strength": "example",
"description": "Codes for medications, devices, conditions and other interventions"
},
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Conditions or Focus of Study"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "ResearchStudy.contact",
"path": "ResearchStudy.contact",
"short": "Contact details for the study",
"definition": "Contact details to assist a user in learning more about or engaging with the study.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Central Contact; Central Contact Backup; Overall Study Officials; Facility Contact & Backup (if Study tied to only one location); Investigators"
}
]
},
{
"id": "ResearchStudy.relatedArtifact",
"path": "ResearchStudy.relatedArtifact",
"short": "References and dependencies",
"definition": "Citations, references and other related documents.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedArtifact"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Citations, Links, Available Study Data/Documents"
}
]
},
{
"id": "ResearchStudy.keyword",
"path": "ResearchStudy.keyword",
"short": "Used to search for the study",
"definition": "Key terms to aid in searching for or filtering the study.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResearchStudyKeyword"
}
],
"strength": "example",
"description": "Words associated with the study that may be useful in discovery"
},
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Keywords"
}
]
},
{
"id": "ResearchStudy.jurisdiction",
"path": "ResearchStudy.jurisdiction",
"short": "Geographic region(s) for study",
"definition": "Indicates a country, state or other region where the study is taking place.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "ResearchStudy.description",
"path": "ResearchStudy.description",
"short": "What this is study doing",
"definition": "A full description of how the study is being conducted.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Detailed Description"
}
]
},
{
"id": "ResearchStudy.enrollment",
"path": "ResearchStudy.enrollment",
"short": "Inclusion & exclusion criteria",
"definition": "Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. \" 200 female Europeans between the ages of 20 and 45 with early onset diabetes\".",
"comment": "The Group referenced should not generally enumerate specific subjects. Subjects will be linked to the study using the ResearchSubject resource.",
"alias": [
"patient"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Enrollment; Number of Groups/Cohorts (= number of \"enrollment\" instances); Groups (Group/Cohort Label = Group.name; Group/Cohort Description = Group.description); Eligibility (Group criteria)"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "ResearchStudy.period",
"path": "ResearchStudy.period",
"short": "When the study began and ended",
"definition": "Identifies the start date and the expected (or actual, depending on status) end date for the study.",
"requirements": "[The list of types may be constrained as appropriate for the type of event].",
"alias": [
"timing"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Study Start Date (start); Study Completion Date (end)"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "ResearchStudy.sponsor",
"path": "ResearchStudy.sponsor",
"short": "Organization responsible for the study",
"definition": "The organization responsible for the execution of the study.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Sponsor"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "ResearchStudy.principalInvestigator",
"path": "ResearchStudy.principalInvestigator",
"short": "The individual responsible for the study",
"definition": "Indicates the individual who has primary oversite of the execution of the study.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Principal Investigator"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "ResearchStudy.site",
"path": "ResearchStudy.site",
"short": "Location involved in study execution",
"definition": "Clinic, hospital or other healthcare location that is participating in the study.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Facility"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "ResearchStudy.reasonStopped",
"path": "ResearchStudy.reasonStopped",
"short": "Reason for terminating study early",
"definition": "A description and/or code explaining the premature termination of the study.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Why Study Stopped"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "ResearchStudy.note",
"path": "ResearchStudy.note",
"short": "Comments made about the event",
"definition": "Comments made about the event by the performer, subject or other participants.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
]
},
{
"id": "ResearchStudy.arm",
"path": "ResearchStudy.arm",
"short": "Defined path through the study for a subject",
"definition": "Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Arms"
}
]
},
{
"id": "ResearchStudy.arm.name",
"path": "ResearchStudy.arm.name",
"short": "Label for study arm",
"definition": "Unique, human-readable label for this arm of the study.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Arm Label"
}
]
},
{
"id": "ResearchStudy.arm.code",
"path": "ResearchStudy.arm.code",
"short": "Categorization of study arm",
"definition": "Categorization of study arm, e.g. experimental, active comparator, placebo comparater.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Arm Type"
}
]
},
{
"id": "ResearchStudy.arm.description",
"path": "ResearchStudy.arm.description",
"short": "Short explanation of study path",
"definition": "A succinct description of the path through the study that would be followed by a subject adhering to this arm.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "clinicaltrials-gov",
"map": "Arm Description"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change