# Get FHIR r4 research study by ID

Endpoint: GET /site/{siteId}/fhir/research-study/{id}
Version: 1.0
Security: bearer, bearer

## Path parameters:

  - `id` (string, required)
    ID of the ResearchStudy

  - `siteId` (string, required)
    Site identifier

## Response 200 fields (application/json):

  - `resourceType` (any, required)
    This is a ResearchStudy resource
    Enum: "ResearchStudy"

  - `id` (string)
    Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive.
    Example: "example-id"

  - `meta` (object)
    The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

  - `meta.id` (string)
    An extension object type #string.
    Example: "example-string"

  - `meta.extension` (array)
    May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `meta.versionId` (object)
    An extension object type #id.

  - `meta._versionId` (object)
    An extension object type #Element.

  - `meta.lastUpdated` (object)
    An extension object type #instant.

  - `meta._lastUpdated` (object)
    An extension object type #Element.

  - `meta.source` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `meta._source` (object)
    An extension object type #Element.

  - `meta.profile` (array)
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
    Example: ["http://example.org/Profile"]

  - `meta.security` (array)
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

  - `meta.tag` (array)
    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

  - `implicitRules` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_implicitRules` (object)
    Base definition for all elements in a resource.

  - `language` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_language` (object)
    Base definition for all elements in a resource.

  - `text` (object)
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.

  - `text.status` (any)
    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    Enum: "generated", "extensions", "additional", "empty"

  - `text._status` (object)
    An extension object type #Element.

  - `text.div` (string, required)
    An extension object type #xhtml.
    Example: "<div>Example</div>"

  - `contained` (array)
    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.

  - `extension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `extension.url` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `extension._url` (object)
    An extension object type #Element.

  - `extension.valueBase64Binary` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "U2FtcGxl"

  - `extension._valueBase64Binary` (object)
    An extension object type #Element.

  - `extension.valueBoolean` (boolean)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: true

  - `extension._valueBoolean` (object)
    An extension object type #Element.

  - `extension.valueCanonical` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "http://example.org/Profile"

  - `extension._valueCanonical` (object)
    An extension object type #Element.

  - `extension.valueCode` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "sample-code"

  - `extension._valueCode` (object)
    An extension object type #Element.

  - `extension.valueDate` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01"

  - `extension._valueDate` (object)
    An extension object type #Element.

  - `extension.valueDateTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueDateTime` (object)
    An extension object type #Element.

  - `extension.valueDecimal` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1.23

  - `extension._valueDecimal` (object)
    An extension object type #Element.

  - `extension.valueId` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-id"

  - `extension._valueId` (object)
    An extension object type #Element.

  - `extension.valueInstant` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueInstant` (object)
    An extension object type #Element.

  - `extension.valueInteger` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valueInteger` (object)
    An extension object type #Element.

  - `extension.valueMarkdown` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "Sample markdown text"

  - `extension._valueMarkdown` (object)
    An extension object type #Element.

  - `extension.valueOid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:oid:1.2.3.4.5"

  - `extension._valueOid` (object)
    An extension object type #Element.

  - `extension.valuePositiveInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valuePositiveInt` (object)
    An extension object type #Element.

  - `extension.valueString` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-string"

  - `extension._valueString` (object)
    An extension object type #Element.

  - `extension.valueTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "12:00:00"

  - `extension._valueTime` (object)
    An extension object type #Element.

  - `extension.valueUnsignedInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).

  - `extension._valueUnsignedInt` (object)
    An extension object type #Element.

  - `extension.valueUri` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org/resource"

  - `extension._valueUri` (object)
    An extension object type #Element.

  - `extension.valueUrl` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org"

  - `extension._valueUrl` (object)
    An extension object type #Element.

  - `extension.valueUuid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"

  - `extension._valueUuid` (object)
    An extension object type #Element.

  - `extension.valueAddress` (object)
    An extension object type #Address.

  - `extension.valueAge` (object)
    An extension object type #Age.

  - `extension.valueAnnotation` (object)
    An extension object type #Annotation.

  - `extension.valueAttachment` (object)
    An extension object type #Attachment.

  - `extension.valueCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `extension.valueCoding` (object)
    An extension object type #Coding.

  - `extension.valueContactPoint` (object)
    An extension object type #ContactPoint.

  - `extension.valueCount` (object)
    An extension object type #Count.

  - `extension.valueDistance` (object)
    An extension object type #Distance.

  - `extension.valueDuration` (object)
    An extension object type #Duration.

  - `extension.valueHumanName` (object)
    An extension object type #HumanName.

  - `extension.valueIdentifier` (object)
    An extension object type #Identifier.

  - `extension.valueMoney` (object)
    An extension object type #Money.

  - `extension.valuePeriod` (object)
    An extension object type #Period.

  - `extension.valueQuantity` (object)
    An extension object type #Quantity.

  - `extension.valueRange` (object)
    An extension object type #Range.

  - `extension.valueRatio` (object)
    An extension object type #Ratio.

  - `extension.valueReference` (object)
    An extension object type #Reference.

  - `extension.valueSampledData` (object)
    An extension object type #SampledData.

  - `extension.valueSignature` (object)
    An extension object type #Signature.

  - `extension.valueTiming` (object)
    An extension object type #Timing.

  - `extension.valueContactDetail` (object)
    An extension object type #ContactDetail.

  - `extension.valueContributor` (object)
    An extension object type #Contributor.

  - `extension.valueDataRequirement` (object)
    An extension object type #DataRequirement.

  - `extension.valueExpression` (object)
    An extension object type #Expression.

  - `extension.valueParameterDefinition` (object)
    An extension object type #ParameterDefinition.

  - `extension.valueRelatedArtifact` (object)
    An extension object type #RelatedArtifact.

  - `extension.valueTriggerDefinition` (object)
    An extension object type #TriggerDefinition.

  - `extension.valueUsageContext` (object)
    An extension object type #UsageContext.

  - `extension.valueDosage` (object)
    An extension object type #Dosage.

  - `extension.valueMeta` (object)
    An extension object type #Meta.

  - `modifierExtension` (array)
    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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `identifier` (array)
    Identifiers assigned to this research study by the sponsor or other systems.

  - `identifier.use` (any)
    The purpose of this identifier.
    Enum: "usual", "official", "temp", "secondary", "old"

  - `identifier._use` (object)
    An extension object type #Element.

  - `identifier.type` (object)
    An extension object type #CodeableConcept.

  - `identifier.system` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `identifier._system` (object)
    An extension object type #Element.

  - `identifier.value` (string)
    An extension object type #string.
    Example: "example-string"

  - `identifier._value` (object)
    An extension object type #Element.

  - `identifier.period` (object)
    An extension object type #Period.

  - `identifier.assigner` (object)
    An extension object type #Reference.

  - `title` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_title` (object)
    Base definition for all elements in a resource.

  - `protocol` (array)
    The set of steps expected to be performed as part of the execution of the study.

  - `protocol.reference` (string)
    An extension object type #string.
    Example: "example-string"

  - `protocol._reference` (object)
    An extension object type #Element.

  - `protocol.type` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `protocol._type` (object)
    An extension object type #Element.

  - `protocol.identifier` (object)
    An extension object type #Identifier.

  - `protocol.display` (string)
    An extension object type #string.
    Example: "example-string"

  - `protocol._display` (object)
    An extension object type #Element.

  - `partOf` (array)
    A larger research study of which this particular study is a component or step.

  - `status` (any)
    The current state of the study.
    Enum: "active", "administratively-completed", "approved", "closed-to-accrual", "closed-to-accrual-and-intervention", "completed", "disapproved", "in-review", "temporarily-closed-to-accrual", "temporarily-closed-to-accrual-and-intervention", "withdrawn"

  - `_status` (object)
    Base definition for all elements in a resource.

  - `primaryPurposeType` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `primaryPurposeType.coding` (array)
    A reference to a code defined by a terminology system.

  - `primaryPurposeType.text` (string)
    An extension object type #string.
    Example: "example-string"

  - `primaryPurposeType._text` (object)
    An extension object type #Element.

  - `phase` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `category` (array)
    Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.

  - `focus` (array)
    The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.

  - `condition` (array)
    The condition that is the focus of the study.  For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.

  - `contact` (array)
    Contact details to assist a user in learning more about or engaging with the study.

  - `contact.name` (string)
    An extension object type #string.
    Example: "example-string"

  - `contact._name` (object)
    An extension object type #Element.

  - `contact.telecom` (array)
    The contact details for the individual (if a name was provided) or the organization.

  - `relatedArtifact` (array)
    Citations, references and other related documents.

  - `relatedArtifact.type` (any)
    The type of relationship to the related artifact.
    Enum: "documentation", "justification", "citation", "predecessor", "successor", "derived-from", "depends-on", "composed-of"

  - `relatedArtifact.label` (string)
    An extension object type #string.
    Example: "example-string"

  - `relatedArtifact._label` (object)
    An extension object type #Element.

  - `relatedArtifact.citation` (object)
    An extension object type #markdown.

  - `relatedArtifact._citation` (object)
    An extension object type #Element.

  - `relatedArtifact.url` (string)
    An extension object type #url.
    Example: "https://example.org"

  - `relatedArtifact.document` (object)
    An extension object type #Attachment.

  - `relatedArtifact.resource` (string)
    An extension object type #canonical.
    Example: "http://example.org/Profile"

  - `keyword` (array)
    Key terms to aid in searching for or filtering the study.

  - `location` (array)
    Indicates a country, state or other region where the study is taking place.

  - `description` (string)
    A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
    Example: "Sample markdown text"

  - `_description` (object)
    Base definition for all elements in a resource.

  - `enrollment` (array)
    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".

  - `period` (object)
    A time period defined by a start and end date and optionally time.

  - `period.start` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `period._start` (object)
    An extension object type #Element.

  - `period.end` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `period._end` (object)
    An extension object type #Element.

  - `sponsor` (object)
    A reference from one resource to another.

  - `principalInvestigator` (object)
    A reference from one resource to another.

  - `site` (array)
    A facility in which study activities are conducted.

  - `reasonStopped` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `note` (array)
    Comments made about the study by the performer, subject or other participants.

  - `note.authorReference` (object)
    An extension object type #Reference.

  - `note.authorString` (string)
    The individual responsible for making the annotation.
    Example: "example-string"

  - `note._authorString` (object)
    An extension object type #Element.

  - `note.time` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `note._time` (object)
    An extension object type #Element.

  - `note.text` (object)
    An extension object type #markdown.

  - `arm` (array)
    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.

  - `arm.modifierExtension` (array)
    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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `arm.description` (string)
    An extension object type #string.
    Example: "example-string"

  - `arm._description` (object)
    An extension object type #Element.

  - `objective` (array)
    A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.

## Response 401 fields (application/json):

  - `message` (string, required)
    Error message indicating unauthorized access.
    Example: "Unauthorized"

  - `statusCode` (number, required)
    HTTP status code for unauthorized access.
    Example: 401


## Response 400 fields

## Response 404 fields