Skip to main content

Contract

Trial Use 1 Financial

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

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Contract
InteractionMethodPath
ReadGET/fhir/R4/Contract/[id]
VreadGET/fhir/R4/Contract/[id]/_history/[vid]
UpdatePUT/fhir/R4/Contract/[id]
PatchPATCH/fhir/R4/Contract/[id]
DeleteDELETE/fhir/R4/Contract/[id]
CreatePOST/fhir/R4/Contract
SearchGET/fhir/R4/Contract
HistoryGET/fhir/R4/Contract/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Contract number
urluri0..1Basal definition
versionstring0..1Business edition
statuscode0..1amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated modifier
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
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
authoritystringhttp://hl7.org/fhir/SearchParameter/Contract-authority
domainstringhttp://hl7.org/fhir/SearchParameter/Contract-domain
identifierstringhttp://hl7.org/fhir/SearchParameter/Contract-identifier
instantiatesstringhttp://hl7.org/fhir/SearchParameter/Contract-instantiates
issuedstringhttp://hl7.org/fhir/SearchParameter/Contract-issued
patientstringhttp://hl7.org/fhir/SearchParameter/Contract-patient
signerstringhttp://hl7.org/fhir/SearchParameter/Contract-signer
statusstringhttp://hl7.org/fhir/SearchParameter/Contract-status
subjectstringhttp://hl7.org/fhir/SearchParameter/Contract-subject
urlstringhttp://hl7.org/fhir/SearchParameter/Contract-url

Reference​

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