# Get FHIR r4 document reference by ID

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

## Path parameters:

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

  - `siteId` (string, required)
    Site identifier

## Response 200 fields (application/json):

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

  - `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.
    Example: [{"resourceType":"Practitioner","id":"a2","name":[{"family":"Smitty","given":["Gerald"]}]}]

  - `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).

  - `masterIdentifier` (object)
    An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

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

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

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

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

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

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

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

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

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

  - `identifier` (array)
    Other identifiers associated with the document, including version independent identifiers.
    Example: [{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"}]

  - `status` (any)
    The status of this document reference.
    Enum: "current", "superseded", "entered-in-error"

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

  - `docStatus` (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"

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

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

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

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

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

  - `category` (array)
    A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
    Example: [{"coding":[{"system":"http://ihe.net/xds/connectathon/classCodes","code":"History and Physical","display":"History and Physical"}]}]

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

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

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

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

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

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

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

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

  - `date` (string)
    An instant in time - known at least to the second
    Example: "2024-01-01T00:00:00Z"

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

  - `author` (array)
    Identifies who is responsible for adding the information to the document.
    Example: [{"reference":"Practitioner/xcda1"},{"reference":"#a2"}]

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

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

  - `relatesTo` (array)
    Relationships that this document has with other document references that already exist.
    Example: [{"code":"appends","target":{"reference":"DocumentReference/example"}}]

  - `relatesTo.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).

  - `relatesTo.code` (any)
    The type of relationship that this document has with anther document.
    Enum: "replaces", "transforms", "signs", "appends"

  - `relatesTo._code` (object)
    An extension object type #Element.

  - `relatesTo.target` (object, required)
    An extension object type #Reference.

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

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

  - `securityLabel` (array)
    A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
    Example: [{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-Confidentiality","code":"V","display":"very restricted"}]}]

  - `content` (array, required)
    The document and format referenced. There may be multiple content element repetitions, each with a different format.
    Example: [{"attachment":{"contentType":"application/hl7-v3+xml","language":"en-US","url":"http://example.org/xds/mhd/Binary/07a6483f-732b-461e-86b6-edb665c45510","size":3654,"hash":"2jmj7l5rSw0yVb/vlWAYkK/YBwk=","title":"Physical","creation":"2005-12-24T09:35:00+11:00"},"format":{"system":"urn:oid:1.3.6.1.4.1.19376.1.2.3","code":"urn:ihe:pcc:handp:2008","display":"History and Physical Specification"}}]

  - `content.attachment` (object, required)
    An extension object type #Attachment.

  - `content.format` (object)
    An extension object type #Coding.

  - `context` (object)
    A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

  - `context.encounter` (array)
    Describes the clinical encounter or type of care that the document content is associated with.

  - `context.event` (array)
    This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

  - `context.facilityType` (object)
    An extension object type #CodeableConcept.

  - `context.practiceSetting` (object)
    An extension object type #CodeableConcept.

  - `context.sourcePatientInfo` (object)
    An extension object type #Reference.

  - `context.related` (array)
    Related identifiers or resources associated with the DocumentReference.

## 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