Contract - FHIR Resource (stu3)
This Contract Resource uses the FHIR API standard for access and structure.
Validate an Contract FHIR Resource (stu3)
Contract Attributes
AttributeField is listTypeDescription
Description: Domain in which this Contract applies
FHIR Version: stu3
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: When this Contract was issued
FHIR Version: stu3
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: Entity being ascribed responsibility
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"agent": Learn more about the (Contract) agent FHIR attribute
Description: Context of the Contract
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"topic": Learn more about the (Contract) topic FHIR attribute
Description: Subtype within the context of type
FHIR Version: stu3
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: Security Labels that define affected resources
FHIR Version: stu3
Attribute Type : Coding
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"securityLabel": Learn more about the (Contract) securityLabel FHIR attribute
Description: Contract Target Entity
FHIR Version: stu3
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: Contract Legal Language
FHIR Version: stu3
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: Rationale for the stiplulated action
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"actionReason": Learn more about the (Contract) actionReason FHIR attribute
Description: Type or form
FHIR Version: stu3
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: Contract Friendly Language
FHIR Version: stu3
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: amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
FHIR Version: stu3
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: Contract Valued Item List
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valuedItem": Learn more about the (Contract) valuedItem FHIR attribute
Description: Action stipulated by this Contract
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"action": Learn more about the (Contract) action FHIR attribute
Description: Authority under which this Contract has standing
FHIR Version: stu3
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: Decision by Grantor
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"decisionType": Learn more about the (Contract) decisionType FHIR attribute
Description: Content derived from the basal information
FHIR Version: stu3
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: Contract Term List
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"term": Learn more about the (Contract) term FHIR attribute
Description: "bindingAttachment" : { Attachment },
FHIR Version: stu3
Attribute Type : Attachment
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"bindingAttachment": Learn more about the (Contract) bindingAttachment FHIR attribute
Description: Computable Contract Language
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"rule": Learn more about the (Contract) rule FHIR attribute
Description: Effective time
FHIR Version: stu3
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 Signatory
FHIR Version: stu3
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: "bindingReference" : { Reference(Composition|DocumentReference|
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"bindingReference": Learn more about the (Contract) bindingReference FHIR attribute
Description: Contract number
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Singleton
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
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 them like so:
https://api.1up.health/fhir/stu3/Contract?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
agent | reference | agent.actor |
authority | reference | authority |
domain | reference | domain |
identifier | text | identifier |
issued | date | issued |
patient | reference | subject |
signer | reference | signer.party |
subject | reference | subject |
term-topic | reference | term.topic |
