ResearchSubject - FHIR Resource (r4)
This ResearchSubject Resource uses the
FHIR API standard for access and structure.
Validate an ResearchSubject FHIR Resource (r4)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
actualArm | false | string | # What path was followed |
assignedArm | false | string | # What path should be followed |
consent | false | Reference | # Agreement to participate in study |
identifier | true | Identifier | # Business Identifier for research subject in a study |
individual | false | Reference | # Who is part of study |
period | false | Period | # Start and end of participation |
status | false | code | # candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn |
study | false | Reference | # Study subject is part of |
ResearchSubject Example
{
"resourceType": "ResearchSubject",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>"
},
"identifier": [
{
"type": {
"text": "Subject id"
},
"system": "http://example.org/studysubjectids",
"value": "123"
}
],
"status": "candidate",
"study": {
"reference": "ResearchStudy/example"
},
"individual": {
"reference": "Patient/example"
}
}
ResearchSubject Structure
{
"resourceType" : "ResearchSubject",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier for research subject in a study
"status" : "<code>", // R! candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn
"period" : { Period }, // Start and end of participation
"study" : { Reference(ResearchStudy) }, // R! Study subject is part of
"individual" : { Reference(Patient) }, // R! Who is part of study
"assignedArm" : "<string>", // What path should be followed
"actualArm" : "<string>", // What path was followed
"consent" : { Reference(Consent) } // Agreement to participate in study
}
ResearchSubject Search Parameters
The following search parameters can be used to query ResearchSubject resources. Just submit them like so:
https://api.1up.health/fhir/r4/ResearchSubject?query-param=queryvalue
Search Parameter | Field Type | Resource Fields Searched |
---|
date | date | period |
identifier | text | identifier |
individual | reference | individual |
patient | reference | individual |
status | text | status |
study | reference | study |