Contract - FHIR Resource (r4)
This Contract Resource uses the FHIR API standard for access and structure.
Validate an Contract FHIR Resource (r4)
Contract Attributes
AttributeField is listTypeDescription
Description: Contract number
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://happyvalley.com/contract",
"value": "12347"
}
]Learn more about the (Contract) identifier FHIR attribute
Description: Basal definition
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (Contract) url FHIR attribute
Description: Business edition
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (Contract) version FHIR attribute
Description: amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (Contract) status FHIR attribute
Description: Negotiation status
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"legalState": Learn more about the (Contract) legalState FHIR attribute
Description: Source Contract Definition
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesCanonical": Learn more about the (Contract) instantiatesCanonical FHIR attribute
Description: External Contract Definition
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesUri": Learn more about the (Contract) instantiatesUri FHIR attribute
Description: Content derived from the basal information
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contentDerivative": Learn more about the (Contract) contentDerivative FHIR attribute
Description: When this Contract was issued
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"issued": Learn more about the (Contract) issued FHIR attribute
Description: Effective time
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"applies": Learn more about the (Contract) applies FHIR attribute
Description: Contract cessation cause
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"expirationType": Learn more about the (Contract) expirationType FHIR attribute
Description: Contract Target Entity
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": Learn more about the (Contract) subject FHIR attribute
Description: Authority under which this Contract has standing
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"authority": Learn more about the (Contract) authority FHIR attribute
Description: A sphere of control governed by an authoritative jurisdiction, organization, or person
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"domain": Learn more about the (Contract) domain FHIR attribute
Description: Specific Location
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"site": Learn more about the (Contract) site FHIR attribute
Description: Computer friendly designation
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (Contract) name FHIR attribute
Description: Human Friendly name
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": Learn more about the (Contract) title FHIR attribute
Description: Subordinate Friendly name
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subtitle": Learn more about the (Contract) subtitle FHIR attribute
Description: Acronym or short name
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"alias": Learn more about the (Contract) alias FHIR attribute
Description: Source of Contract
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"author": Learn more about the (Contract) author FHIR attribute
Description: Range of Legal Concerns
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"scope": Learn more about the (Contract) scope FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"topic[x]": Learn more about the (Contract) topic[x] FHIR attribute
Description: Legal instrument category
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Contract) type FHIR attribute
Description: Subtype within the context of type
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subType": Learn more about the (Contract) subType FHIR attribute
Description: Contract precursor content
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contentDefinition": Learn more about the (Contract) contentDefinition FHIR attribute
Description: Contract Term List
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
}
]
}
]
}
]Learn more about the (Contract) term FHIR attribute
Description: Extra Information
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supportingInfo": Learn more about the (Contract) supportingInfo FHIR attribute
Description: Key event in Contract History
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relevantHistory": Learn more about the (Contract) relevantHistory FHIR attribute
Description: Contract Signatory
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"signer": Learn more about the (Contract) signer FHIR attribute
Description: Contract Friendly Language
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"friendly": Learn more about the (Contract) friendly FHIR attribute
Description: Contract Legal Language
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"legal": Learn more about the (Contract) legal FHIR attribute
Description: Computable Contract Language
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"rule": [
{
"contentAttachment": {
"contentType": "application/txt",
"url": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
}
]Learn more about the (Contract) rule FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"legallyBinding[x]": Learn more about the (Contract) legallyBinding[x] FHIR attribute
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 Parameter | Field Type | Resource Fields Searched |
|---|---|---|
authority | reference | authority |
domain | reference | domain |
identifier | text | identifier |
instantiates | uri | instantiatesUri |
issued | date | issued |
patient | reference | subject.where |
signer | reference | signer.party |
status | text | status |
subject | reference | subject |
url | uri | url |
