ResearchSubject - FHIR Resource (r4)
This ResearchSubject Resource uses the FHIR API standard for access and structure.
Validate an ResearchSubject FHIR Resource (r4)
ResearchSubject Attributes
AttributeField is listTypeDescription
Description: Business Identifier for research subject in a study
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"type": {
"text": "Subject id"
},
"system": "http://example.org/studysubjectids",
"value": "123"
}
]Learn more about the (ResearchSubject) identifier FHIR attribute
Description: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "candidate"Learn more about the (ResearchSubject) status FHIR attribute
Description: Start and end of participation
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": Learn more about the (ResearchSubject) period FHIR attribute
Description: Study subject is part of
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"study": {
"reference": "ResearchStudy/example"
}Learn more about the (ResearchSubject) study FHIR attribute
Description: Who is part of study
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"individual": {
"reference": "Patient/example"
}Learn more about the (ResearchSubject) individual FHIR attribute
Description: What path should be followed
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"assignedArm": Learn more about the (ResearchSubject) assignedArm FHIR attribute
Description: What path was followed
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"actualArm": Learn more about the (ResearchSubject) actualArm FHIR attribute
Description: Agreement to participate in study
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"consent": Learn more about the (ResearchSubject) consent FHIR attribute
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 |
