# Get FHIR r4 contract by ID
Endpoint: GET /site/{siteId}/fhir/contract/{id}
Version: 1.0
Security: bearer, bearer
## Path parameters:
- `id` (string, required)
ID of the Contract
- `siteId` (string, required)
Site identifier
## Response 200 fields (application/json):
- `resourceType` (any, required)
This is a Contract resource
Enum: "Contract"
- `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: "
Example
"
- `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)
Unique identifier for this Contract or a derivative that references a Source Contract.
Example: [{"system":"http://happyvalley.com/contract","value":"12347"}]
- `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.
- `url` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_url` (object)
Base definition for all elements in a resource.
- `version` (string)
A sequence of Unicode characters
Example: "example-string"
- `_version` (object)
Base definition for all elements in a resource.
- `status` (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"
- `_status` (object)
Base definition for all elements in a resource.
- `legalState` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `legalState.coding` (array)
A reference to a code defined by a terminology system.
- `legalState.text` (string)
An extension object type #string.
Example: "example-string"
- `legalState._text` (object)
An extension object type #Element.
- `instantiatesCanonical` (object)
A reference from one resource to another.
- `instantiatesCanonical.reference` (string)
An extension object type #string.
Example: "example-string"
- `instantiatesCanonical._reference` (object)
An extension object type #Element.
- `instantiatesCanonical.type` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `instantiatesCanonical._type` (object)
An extension object type #Element.
- `instantiatesCanonical.identifier` (object)
An extension object type #Identifier.
- `instantiatesCanonical.display` (string)
An extension object type #string.
Example: "example-string"
- `instantiatesCanonical._display` (object)
An extension object type #Element.
- `instantiatesUri` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_instantiatesUri` (object)
Base definition for all elements in a resource.
- `contentDerivative` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `issued` (string)
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
- `_issued` (object)
Base definition for all elements in a resource.
- `applies` (object)
A time period defined by a start and end date and optionally time.
- `applies.start` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `applies._start` (object)
An extension object type #Element.
- `applies.end` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `applies._end` (object)
An extension object type #Element.
- `expirationType` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `subject` (array)
The target entity impacted by or of interest to parties to the agreement.
- `authority` (array)
A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.
- `domain` (array)
Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.
- `site` (array)
Sites in which the contract is complied with, exercised, or in force.
- `name` (string)
A sequence of Unicode characters
Example: "example-string"
- `_name` (object)
Base definition for all elements in a resource.
- `title` (string)
A sequence of Unicode characters
Example: "example-string"
- `_title` (object)
Base definition for all elements in a resource.
- `subtitle` (string)
A sequence of Unicode characters
Example: "example-string"
- `_subtitle` (object)
Base definition for all elements in a resource.
- `alias` (array)
Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.
Example: ["example-string"]
- `_alias` (array)
Extensions for alias
- `author` (object)
A reference from one resource to another.
- `scope` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `topicCodeableConcept` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `topicReference` (object)
A reference from one resource to another.
- `type` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `subType` (array)
Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.
- `contentDefinition` (object)
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
- `contentDefinition.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).
- `contentDefinition.subType` (object)
An extension object type #CodeableConcept.
- `contentDefinition.publisher` (object)
An extension object type #Reference.
- `contentDefinition.publicationDate` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `contentDefinition._publicationDate` (object)
An extension object type #Element.
- `contentDefinition.publicationStatus` (string)
An extension object type #code.
Example: "sample-code"
- `contentDefinition._publicationStatus` (object)
An extension object type #Element.
- `contentDefinition.copyright` (object)
An extension object type #markdown.
- `contentDefinition._copyright` (object)
An extension object type #Element.
- `term` (array)
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
Example: [{"offer":{"text":"Can't refuse"},"asset":[{"type":[{"coding":[{"system":"urn:ietf:rfc:3986","code":"RicardianContract"}]}],"subtype":[{"text":"sample"}],"period":[{"start":"2017-06-01"}],"valuedItem":[{"entityCodeableConcept":{"text":"Ford Bobcat"},"identifier":{"system":"http://somewhere.motor-vehicle.com/vin","value":"XXSVT34-7665t952236"},"effectiveTime":"1995","quantity":{"value":1},"unitPrice":{"value":200,"currency":"CAD"},"factor":1,"points":1,"net":{"value":200,"currency":"CAD"}}]}]}]
- `term.issued` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `term._issued` (object)
An extension object type #Element.
- `term.applies` (object)
An extension object type #Period.
- `term.topicCodeableConcept` (object)
An extension object type #CodeableConcept.
- `term.topicReference` (object)
An extension object type #Reference.
- `term.securityLabel` (array)
Security labels that protect the handling of information about the term and its elements, which may be specifically identified..
- `term.offer` (object, required)
An extension object type #Contract_Offer.
- `term.asset` (array)
Contract Term Asset List.
- `term.action` (array)
An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
- `term.group` (array)
Nested group of Contract Provisions.
- `supportingInfo` (array)
Information that may be needed by/relevant to the performer in their execution of this term action.
- `relevantHistory` (array)
Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.
- `signer` (array)
Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.
- `signer.type` (object, required)
An extension object type #Coding.
- `signer.party` (object, required)
An extension object type #Reference.
- `signer.signature` (array, required)
Legally binding Contract DSIG signature contents in Base64.
- `friendly` (array)
The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
- `friendly.contentAttachment` (object)
An extension object type #Attachment.
- `friendly.contentReference` (object)
An extension object type #Reference.
- `legal` (array)
List of Legal expressions or representations of this Contract.
- `rule` (array)
List of Computable Policy Rule Language Representations of this Contract.
Example: [{"contentAttachment":{"contentType":"application/txt","url":"http://www.rfc-editor.org/bcp/bcp13.txt"}}]
- `legallyBindingAttachment` (object)
For referring to data content defined in other formats.
- `legallyBindingAttachment.contentType` (string)
An extension object type #code.
Example: "sample-code"
- `legallyBindingAttachment._contentType` (object)
An extension object type #Element.
- `legallyBindingAttachment.language` (string)
An extension object type #code.
Example: "sample-code"
- `legallyBindingAttachment._language` (object)
An extension object type #Element.
- `legallyBindingAttachment.data` (string)
An extension object type #base64Binary.
Example: "U2FtcGxl"
- `legallyBindingAttachment._data` (object)
An extension object type #Element.
- `legallyBindingAttachment.url` (string)
An extension object type #url.
Example: "https://example.org"
- `legallyBindingAttachment.size` (integer)
An extension object type #unsignedInt.
- `legallyBindingAttachment._size` (object)
An extension object type #Element.
- `legallyBindingAttachment.hash` (string)
An extension object type #base64Binary.
Example: "U2FtcGxl"
- `legallyBindingAttachment._hash` (object)
An extension object type #Element.
- `legallyBindingAttachment.title` (string)
An extension object type #string.
Example: "example-string"
- `legallyBindingAttachment._title` (object)
An extension object type #Element.
- `legallyBindingAttachment.creation` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `legallyBindingAttachment._creation` (object)
An extension object type #Element.
- `legallyBindingReference` (object)
A reference from one resource to another.
## 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