Contract - FHIR Resource (stu3)


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

Validate an Contract FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
actiontrueCodeableConcept Action stipulated by this Contract
actionReasontrueCodeableConcept Rationale for the stiplulated action
agenttrueData Type Entity being ascribed responsibility
appliesfalsePeriod Effective time
authoritytrueReference Authority under which this Contract has standing
bindingAttachmentfalseAttachment "bindingAttachment" : { Attachment },
bindingReferencefalseReference "bindingReference" : { Reference(Composition|DocumentReference|
contentDerivativefalseCodeableConcept Content derived from the basal information
decisionTypefalseCodeableConcept Decision by Grantor
domaintrueReference Domain in which this Contract applies
friendlytrueData Type Contract Friendly Language
identifierfalseIdentifier Contract number
issuedfalsedateTime When this Contract was issued
legaltrueData Type Contract Legal Language
ruletrueData Type Computable Contract Language
securityLabeltrueCoding Security Labels that define affected resources
signertrueData Type Contract Signatory
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
termtrueData Type Contract Term List
topictrueReference Context of the Contract
typefalseCodeableConcept Type or form
valuedItemtrueData Type Contract Valued Item List

Contract Example

{
  "resourceType": "Contract",
  "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"
  },
  "id": "C-123"
}

Contract Structure


  
{
  "resourceType" : "Contract",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Contract number
  "status" : "<code>", // amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
  "issued" : "<dateTime>", // When this Contract was issued
  "applies" : { Period }, // Effective time
  "subject" : [{ Reference(Any) }], // Contract Target Entity
  "topic" : [{ Reference(Any) }], // Context of the Contract
  "authority" : [{ Reference(Organization) }], // Authority under which this Contract has standing
  "domain" : [{ Reference(Location) }], // Domain in which this Contract applies
  "type" : { CodeableConcept }, // Type or form
  "subType" : [{ CodeableConcept }], // Subtype within the context of type
  "action" : [{ CodeableConcept }], // Action stipulated by this Contract
  "actionReason" : [{ CodeableConcept }], // Rationale for the stiplulated action
  "decisionType" : { CodeableConcept }, // Decision by Grantor
  "contentDerivative" : { CodeableConcept }, // Content derived from the basal information
  "securityLabel" : [{ Coding }], // Security Labels that define affected resources
  "agent" : [{ // Entity being ascribed responsibility
    "actor" : { Reference(Contract|Device|Group|Location|Organization|Patient|
    Practitioner|RelatedPerson|Substance) }, // R!  Contract Agent Type
    "role" : [{ CodeableConcept }] // Role type of the agent
  }],
  "signer" : [{ // Contract Signatory
    "type" : { Coding }, // R!  Contract Signatory Role
    "party" : { Reference(Organization|Patient|Practitioner|RelatedPerson) }, // R!  Contract Signatory Party
    "signature" : [{ Signature }] // R!  Contract Documentation Signature
  }],
  "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
  }],
  "term" : [{ // Contract Term List
    "identifier" : { Identifier }, // Contract Term Number
    "issued" : "<dateTime>", // Contract Term Issue Date Time
    "applies" : { Period }, // Contract Term Effective Time
    "type" : { CodeableConcept }, // Contract Term Type or Form
    "subType" : { CodeableConcept }, // Contract Term Type specific classification
    "topic" : [{ Reference(Any) }], // Context of the Contract term
    "action" : [{ CodeableConcept }], // Contract Term Activity
    "actionReason" : [{ CodeableConcept }], // Purpose for the Contract Term Action
    "securityLabel" : [{ Coding }], // Security Labels that define affected terms
    "agent" : [{ // Contract Term Agent List
      "actor" : { Reference(Contract|Device|Group|Location|Organization|Patient|
     Practitioner|RelatedPerson|Substance) }, // R!  Contract Term Agent Subject
      "role" : [{ CodeableConcept }] // Type of the Contract Term Agent
    }],
    "text" : "<string>", // Human readable Contract term text
    "valuedItem" : [{ // Contract Term Valued Item List
      // entity[x]: Contract Term Valued Item Type. One of these 2:
      "entityCodeableConcept" : { CodeableConcept },
      "entityReference" : { Reference(Any) },
      "identifier" : { Identifier }, // Contract Term Valued Item Number
      "effectiveTime" : "<dateTime>", // Contract Term Valued Item Effective Tiem
      "quantity" : { Quantity(SimpleQuantity) }, // Contract Term Valued Item Count
      "unitPrice" : { Money }, // Contract Term Valued Item fee, charge, or cost
      "factor" : <decimal>, // Contract Term Valued Item Price Scaling Factor
      "points" : <decimal>, // Contract Term Valued Item Difficulty Scaling Factor
      "net" : { Money } // Total Contract Term Valued Item Value
    }],
    "group" : [{ Content as for Contract.term }] // Nested Contract Term Group
  }],
  // binding[x]: Binding Contract. One of these 2:
  "bindingAttachment" : { Attachment },
  "bindingReference" : { Reference(Composition|DocumentReference|
   QuestionnaireResponse) },
  "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) }
  }]
}


 

Contract Search Parameters

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

https://api.1up.health/fhir/stu3/Contract?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
agentreferenceagent.actor
authorityreferenceauthority
domainreferencedomain
identifiertextidentifier
issueddateissued
patientreferencesubject
signerreferencesigner.party
subjectreferencesubject
term-topicreferenceterm.topic