Contract - FHIR Resource (r4)


This Contract Resource uses the FHIR API standard for access and structure.

Validate an Contract FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
aliastruestring# Acronym or short name
appliesfalsePeriod# Effective time
authorfalseReference# Source of Contract
authoritytrueReference# Authority under which this Contract has standing
contentDefinitionfalseData Type# Contract precursor content
contentDerivativefalseCodeableConcept# Content derived from the basal information
domaintrueReference# A sphere of control governed by an authoritative jurisdiction, organization, or person
expirationTypefalseCodeableConcept# Contract cessation cause
friendlytrueData Type# Contract Friendly Language
identifiertrueIdentifier# Contract number
instantiatesCanonicalfalseReference# Source Contract Definition
instantiatesUrifalseuri# External Contract Definition
issuedfalsedateTime# When this Contract was issued
legaltrueData Type# Contract Legal Language
legalStatefalseCodeableConcept# Negotiation status
legallyBinding[x]falseReference#undefined
namefalsestring# Computer friendly designation
relevantHistorytrueReference# Key event in Contract History
ruletrueData Type# Computable Contract Language
scopefalseCodeableConcept# Range of Legal Concerns
signertrueData Type# Contract Signatory
sitetrueReference# Specific Location
statusfalsecode# amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
subTypetrueCodeableConcept# Subtype within the context of type
subjecttrueReference# Contract Target Entity
subtitlefalsestring# Subordinate Friendly name
supportingInfotrueReference# Extra Information
termtrueData Type# Contract Term List
titlefalsestring# Human Friendly name
topic[x]falseReference#undefined
typefalseCodeableConcept# Legal instrument category
urlfalseuri# Basal definition
versionfalsestring# Business edition

Contract Example

{
  "resourceType": "Contract",
  "id": "C-123",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the contract</div>"
  },
  "identifier": [
    {
      "system": "http://happyvalley.com/contract",
      "value": "12347"
    }
  ],
  "term": [
    {
      "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"
              }
            }
          ]
        }
      ]
    }
  ],
  "rule": [
    {
      "contentAttachment": {
        "contentType": "application/txt",
        "url": "http://www.rfc-editor.org/bcp/bcp13.txt"
      }
    }
  ],
  "legallyBindingAttachment": {
    "contentType": "application/pdf",
    "url": "http://www.aws3.com/storage/doc.pdf"
  }
}

Contract Structure

{
  "resourceType" : "Contract",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Contract number
  "url" : "<uri>", // Basal definition
  "version" : "<string>", // Business edition
  "status" : "<code>", // amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
  "legalState" : { CodeableConcept }, // Negotiation status
  "instantiatesCanonical" : { Reference(Contract) }, // Source Contract Definition
  "instantiatesUri" : "<uri>", // External Contract Definition
  "contentDerivative" : { CodeableConcept }, // Content derived from the basal information
  "issued" : "<dateTime>", // When this Contract was issued
  "applies" : { Period }, // Effective time
  "expirationType" : { CodeableConcept }, // Contract cessation cause
  "subject" : [{ Reference(Any) }], // Contract Target Entity
  "authority" : [{ Reference(Organization) }], // Authority under which this Contract has standing
  "domain" : [{ Reference(Location) }], // A sphere of control governed by an authoritative jurisdiction, organization, or person
  "site" : [{ Reference(Location) }], // Specific Location
  "name" : "<string>", // Computer friendly designation
  "title" : "<string>", // Human Friendly name
  "subtitle" : "<string>", // Subordinate Friendly name
  "alias" : ["<string>"], // Acronym or short name
  "author" : { Reference(Patient|Practitioner|PractitionerRole|Organization) }, // Source of Contract
  "scope" : { CodeableConcept }, // Range of Legal Concerns
  // topic[x]: Focus of contract interest. One of these 2:
  "topicCodeableConcept" : { CodeableConcept },
  "topicReference" : { Reference(Any) },
  "type" : { CodeableConcept }, // Legal instrument category
  "subType" : [{ CodeableConcept }], // Subtype within the context of type
  "contentDefinition" : { // Contract precursor content
    "type" : { CodeableConcept }, // R!  Content structure and use
    "subType" : { CodeableConcept }, // Detailed Content Type Definition
    "publisher" : { Reference(Practitioner|PractitionerRole|Organization) }, // Publisher Entity
    "publicationDate" : "<dateTime>", // When published
    "publicationStatus" : "<code>", // R!  amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
    "copyright" : "<markdown>" // Publication Ownership
  },
  "term" : [{ // Contract Term List
    "identifier" : { Identifier }, // Contract Term Number
    "issued" : "<dateTime>", // Contract Term Issue Date Time
    "applies" : { Period }, // Contract Term Effective Time
    // topic[x]: Term Concern. One of these 2:
    "topicCodeableConcept" : { CodeableConcept },
    "topicReference" : { Reference(Any) },
    "type" : { CodeableConcept }, // Contract Term Type or Form
    "subType" : { CodeableConcept }, // Contract Term Type specific classification
    "text" : "<string>", // Term Statement
    "securityLabel" : [{ // Protection for the Term
      "number" : ["<unsignedInt>"], // Link to Security Labels
      "classification" : { Coding }, // R!  Confidentiality Protection
      "category" : [{ Coding }], // Applicable Policy
      "control" : [{ Coding }] // Handling Instructions
    }],
    "offer" : { // R!  Context of the Contract term
      "identifier" : [{ Identifier }], // Offer business ID
      "party" : [{ // Offer Recipient
        "reference" : [{ Reference(Patient|RelatedPerson|Practitioner|
      PractitionerRole|Device|Group|Organization) }], // R!  Referenced entity
        "role" : { CodeableConcept } // R!  Participant engagement type
      }],
      "topic" : { Reference(Any) }, // Negotiable offer asset
      "type" : { CodeableConcept }, // Contract Offer Type or Form
      "decision" : { CodeableConcept }, // Accepting party choice
      "decisionMode" : [{ CodeableConcept }], // How decision is conveyed
      "answer" : [{ // Response to offer text
        // value[x]: The actual answer response. One of these 12:
        "valueBoolean" : <boolean>
        "valueDecimal" : <decimal>
        "valueInteger" : <integer>
        "valueDate" : "<date>"
        "valueDateTime" : "<dateTime>"
        "valueTime" : "<time>"
        "valueString" : "<string>"
        "valueUri" : "<uri>"
        "valueAttachment" : { Attachment }
        "valueCoding" : { Coding }
        "valueQuantity" : { Quantity }
        "valueReference" : { Reference(Any) }
      }],
      "text" : "<string>", // Human readable offer text
      "linkId" : ["<string>"], // Pointer to text
      "securityLabelNumber" : ["<unsignedInt>"] // Offer restriction numbers
    },
    "asset" : [{ // Contract Term Asset List
      "scope" : { CodeableConcept }, // Range of asset
      "type" : [{ CodeableConcept }], // Asset category
      "typeReference" : [{ Reference(Any) }], // Associated entities
      "subtype" : [{ CodeableConcept }], // Asset sub-category
      "relationship" : { Coding }, // Kinship of the asset
      "context" : [{ // Circumstance of the asset
        "reference" : { Reference(Any) }, // Creator,custodian or owner
        "code" : [{ CodeableConcept }], // Codeable asset context
        "text" : "<string>" // Context description
      }],
      "condition" : "<string>", // Quality desctiption of asset
      "periodType" : [{ CodeableConcept }], // Asset availability types
      "period" : [{ Period }], // Time period of the asset
      "usePeriod" : [{ Period }], // Time period
      "text" : "<string>", // Asset clause or question text
      "linkId" : ["<string>"], // Pointer to asset text
      "answer" : [{ Content as for Contract.term.offer.answer }], // Response to assets
      "securityLabelNumber" : ["<unsignedInt>"], // Asset restriction numbers
      "valuedItem" : [{ // Contract Valued Item List
        // entity[x]: Contract Valued Item Type. One of these 2:
        "entityCodeableConcept" : { CodeableConcept },
        "entityReference" : { Reference(Any) },
        "identifier" : { Identifier }, // Contract Valued Item Number
        "effectiveTime" : "<dateTime>", // Contract Valued Item Effective Tiem
        "quantity" : { Quantity(SimpleQuantity) }, // Count of Contract Valued Items
        "unitPrice" : { Money }, // Contract Valued Item fee, charge, or cost
        "factor" : <decimal>, // Contract Valued Item Price Scaling Factor
        "points" : <decimal>, // Contract Valued Item Difficulty Scaling Factor
        "net" : { Money }, // Total Contract Valued Item Value
        "payment" : "<string>", // Terms of valuation
        "paymentDate" : "<dateTime>", // When payment is due
        "responsible" : { Reference(Organization|Patient|Practitioner|
      PractitionerRole|RelatedPerson) }, // Who will make payment
        "recipient" : { Reference(Organization|Patient|Practitioner|
      PractitionerRole|RelatedPerson) }, // Who will receive payment
        "linkId" : ["<string>"], // Pointer to specific item
        "securityLabelNumber" : ["<unsignedInt>"] // Security Labels that define affected terms
      }]
    }],
    "action" : [{ // Entity being ascribed responsibility
      "doNotPerform" : <boolean>, // True if the term prohibits the  action
      "type" : { CodeableConcept }, // R!  Type or form of the action
      "subject" : [{ // Entity of the action
        "reference" : [{ Reference(Patient|RelatedPerson|Practitioner|
      PractitionerRole|Device|Group|Organization) }], // R!  Entity of the action
        "role" : { CodeableConcept } // Role type of the agent
      }],
      "intent" : { CodeableConcept }, // R!  Purpose for the Contract Term Action
      "linkId" : ["<string>"], // Pointer to specific item
      "status" : { CodeableConcept }, // R!  State of the action
      "context" : { Reference(Encounter|EpisodeOfCare) }, // Episode associated with action
      "contextLinkId" : ["<string>"], // Pointer to specific item
      // occurrence[x]: When action happens. One of these 3:
      "occurrenceDateTime" : "<dateTime>",
      "occurrencePeriod" : { Period },
      "occurrenceTiming" : { Timing },
      "requester" : [{ Reference(Patient|RelatedPerson|Practitioner|
     PractitionerRole|Device|Group|Organization) }], // Who asked for action
      "requesterLinkId" : ["<string>"], // Pointer to specific item
      "performerType" : [{ CodeableConcept }], // Kind of service performer
      "performerRole" : { CodeableConcept }, // Competency of the performer
      "performer" : { Reference(RelatedPerson|Patient|Practitioner|
     PractitionerRole|CareTeam|Device|Substance|Organization|Location) }, // Actor that wil execute (or not) the action
      "performerLinkId" : ["<string>"], // Pointer to specific item
      "reasonCode" : [{ CodeableConcept }], // Why is action (not) needed?
      "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
     DocumentReference|Questionnaire|QuestionnaireResponse) }], // Why is action (not) needed?
      "reason" : ["<string>"], // Why action is to be performed
      "reasonLinkId" : ["<string>"], // Pointer to specific item
      "note" : [{ Annotation }], // Comments about the action
      "securityLabelNumber" : ["<unsignedInt>"] // Action restriction numbers
    }],
    "group" : [{ Content as for Contract.term }] // Nested Contract Term Group
  }],
  "supportingInfo" : [{ Reference(Any) }], // Extra Information
  "relevantHistory" : [{ Reference(Provenance) }], // Key event in Contract History
  "signer" : [{ // Contract Signatory
    "type" : { Coding }, // R!  Contract Signatory Role
    "party" : { Reference(Organization|Patient|Practitioner|PractitionerRole|
    RelatedPerson) }, // R!  Contract Signatory Party
    "signature" : [{ Signature }] // R!  Contract Documentation Signature
  }],
  "friendly" : [{ // Contract Friendly Language
    // content[x]: Easily comprehended representation of this Contract. One of these 2:
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(Composition|DocumentReference|
    QuestionnaireResponse) }
  }],
  "legal" : [{ // Contract Legal Language
    // content[x]: Contract Legal Text. One of these 2:
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(Composition|DocumentReference|
    QuestionnaireResponse) }
  }],
  "rule" : [{ // Computable Contract Language
    // content[x]: Computable Contract Rules. One of these 2:
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(DocumentReference) }
  }],
  // legallyBinding[x]: Binding Contract. One of these 2:
  "legallyBindingAttachment" : { Attachment }
  "legallyBindingReference" : { Reference(Composition|DocumentReference|
   QuestionnaireResponse|Contract) }
}

Contract Search Parameters

The following search parameters can be used to query Contract resources. Just submit them like so:

https://api.1up.health/fhir/r4/Contract?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authorityreferenceauthority
domainreferencedomain
identifiertextidentifier
instantiatesuriinstantiatesUri
issueddateissued
patientreferencesubject.where
signerreferencesigner.party
statustextstatus
subjectreferencesubject
urluriurl