# Contract

Canonical page: https://docs.ovok.com/api/fhir/r4/contract

Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Contract/[id]` |
| Vread | `GET` | `/fhir/R4/Contract/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Contract/[id]` |
| Patch | `PATCH` | `/fhir/R4/Contract/[id]` |
| Delete | `DELETE` | `/fhir/R4/Contract/[id]` |
| Create | `POST` | `/fhir/R4/Contract` |
| Search | `GET` | `/fhir/R4/Contract` |
| History | `GET` | `/fhir/R4/Contract/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Contract number |
| <span id="element-url"></span>`url` | [uri](/fhir-elements/primitive/uri) | `0..1` | Basal definition |
| <span id="element-version"></span>`version` | [string](/fhir-elements/primitive/string) | `0..1` | Business edition |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `0..1` | amended \| appended \| cancelled \| disputed \| entered-in-error \| executable \| executed \| negotiable \| offered \| policy \| rejected \| renewed \| revoked \| resolved \| terminated |
| <span id="element-legal-state"></span>`legalState` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Negotiation status |
| <span id="element-instantiates-canonical"></span>`instantiatesCanonical` | [Reference](/fhir-elements/complex/reference) | `0..1` | Source Contract Definition |
| <span id="element-instantiates-uri"></span>`instantiatesUri` | [uri](/fhir-elements/primitive/uri) | `0..1` | External Contract Definition |
| <span id="element-content-derivative"></span>`contentDerivative` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Content derived from the basal information |
| <span id="element-issued"></span>`issued` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | When this Contract was issued |
| <span id="element-applies"></span>`applies` | [Period](/fhir-elements/complex/period) | `0..1` | Effective time |
| <span id="element-expiration-type"></span>`expirationType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Contract cessation cause |
| <span id="element-subject"></span>`subject` | [Reference](/fhir-elements/complex/reference) | `0..*` | Contract Target Entity |
| <span id="element-authority"></span>`authority` | [Reference](/fhir-elements/complex/reference) | `0..*` | Authority under which this Contract has standing |
| <span id="element-domain"></span>`domain` | [Reference](/fhir-elements/complex/reference) | `0..*` | A sphere of control governed by an authoritative jurisdiction, organization, or person |
| <span id="element-site"></span>`site` | [Reference](/fhir-elements/complex/reference) | `0..*` | Specific Location |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | Computer friendly designation |
| <span id="element-title"></span>`title` | [string](/fhir-elements/primitive/string) | `0..1` | Human Friendly name |
| <span id="element-subtitle"></span>`subtitle` | [string](/fhir-elements/primitive/string) | `0..1` | Subordinate Friendly name |
| <span id="element-alias"></span>`alias` | [string](/fhir-elements/primitive/string) | `0..*` | Acronym or short name |
| <span id="element-author"></span>`author` | [Reference](/fhir-elements/complex/reference) | `0..1` | Source of Contract |
| <span id="element-scope"></span>`scope` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Range of Legal Concerns |
| <span id="element-topic-x"></span>`topic[x]` | [CodeableConcept](/fhir-elements/complex/codeable-concept), [Reference](/fhir-elements/complex/reference) | `0..1` | Focus of contract interest |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Legal instrument category |
| <span id="element-sub-type"></span>`subType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Subtype within the context of type |
| <span id="element-content-definition"></span>`contentDefinition` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Contract precursor content |
| <span id="element-term"></span>`term` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Contract Term List |
| <span id="element-supporting-info"></span>`supportingInfo` | [Reference](/fhir-elements/complex/reference) | `0..*` | Extra Information |
| <span id="element-relevant-history"></span>`relevantHistory` | [Reference](/fhir-elements/complex/reference) | `0..*` | Key event in Contract History |
| <span id="element-signer"></span>`signer` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Contract Signatory |
| <span id="element-friendly"></span>`friendly` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Contract Friendly Language |
| <span id="element-legal"></span>`legal` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Contract Legal Language |
| <span id="element-rule"></span>`rule` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Computable Contract Language |
| <span id="element-legally-binding-x"></span>`legallyBinding[x]` | [Attachment](/fhir-elements/complex/attachment), [Reference](/fhir-elements/complex/reference) | `0..1` | Binding Contract |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `authority` | reference | The authority of the contract |
| `domain` | reference | The domain of the contract |
| `identifier` | token | The identity of the contract |
| `instantiates` | uri | A source definition of the contract |
| `issued` | date | The date/time the contract was issued |
| `patient` | reference | The identity of the subject of the contract (if a patient) |
| `signer` | reference | Contract Signatory Party |
| `status` | token | The status of the contract |
| `subject` | reference | The identity of the subject of the contract |
| `url` | uri | The basal contract definition |

## Reference [#reference]

Official FHIR R4 spec: [Contract](https://hl7.org/fhir/R4/contract.html).  
Maturity: Trial Use 1 (FMM 1).
