Skip to main content

Contract

Trial Use 1 Financial

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Contract
InteractionMethodPath
ReadGET/fhir/R5/Contract/[id]
VreadGET/fhir/R5/Contract/[id]/_history/[vid]
UpdatePUT/fhir/R5/Contract/[id]
PatchPATCH/fhir/R5/Contract/[id]
DeleteDELETE/fhir/R5/Contract/[id]
CreatePOST/fhir/R5/Contract
SearchGET/fhir/R5/Contract?...
HistoryGET/fhir/R5/Contract/[id]/_history
Type-historyGET/fhir/R5/Contract/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..*Contract number
urluri0..1Basal definition
versionstring0..1Business edition
statuscode0..1amended
legalStateCodeableConcept0..1Negotiation status
instantiatesCanonicalReference0..1Source Contract Definition
instantiatesUriuri0..1External Contract Definition
contentDerivativeCodeableConcept0..1Content derived from the basal information
issueddateTime0..1When this Contract was issued
appliesPeriod0..1Effective time
expirationTypeCodeableConcept0..1Contract cessation cause
subjectReference0..*Contract Target Entity
authorityReference0..*Authority under which this Contract has standing
domainReference0..*A sphere of control governed by an authoritative jurisdiction, organization, or person
siteReference0..*Specific Location
namestring0..1Computer friendly designation
titlestring0..1Human Friendly name
subtitlestring0..1Subordinate Friendly name
aliasstring0..*Acronym or short name
authorReference0..1Source of Contract
scopeCodeableConcept0..1Range of Legal Concerns
topic[x]CodeableConcept / Reference0..1Focus of contract interest
typeCodeableConcept0..1Legal instrument category
subTypeCodeableConcept0..*Subtype within the context of type
contentDefinitionBackboneElement0..1Contract precursor content
termBackboneElement0..*Contract Term List
supportingInfoReference0..*Extra Information
relevantHistoryReference0..*Key event in Contract History
signerBackboneElement0..*Contract Signatory
friendlyBackboneElement0..*Contract Friendly Language
legalBackboneElement0..*Contract Legal Language
ruleBackboneElement0..*Computable Contract Language
legallyBinding[x]Attachment / Reference0..1Binding Contract

Resource-specific search parameters

ParameterTypeDescription
authorityreferenceThe authority of the contract
domainreferenceThe domain of the contract
identifiertokenAccount number
instantiatesuriA source definition of the contract
issueddateThe date/time the contract was issued
patientreferenceThe entity that caused the expenses
signerreferenceContract Signatory Party
statustokenThe status of the contract
subjectreferenceThe identity of the subject of the contract
urluriThe basal contract definition

Reference

  • Official FHIR R5 spec: Contract
  • Maturity: Trial Use 1 (FMM 1).