Contract - FHIR Resource (dstu2)
This Contract Resource uses the FHIR API standard for access and structure.
Validate an Contract FHIR Resource (dstu2)
Contract Attributes
AttributeField is listTypeDescription
Description: Domain in which this Contract applies
FHIR Version: dstu2
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: Contract Tyoe
FHIR Version: dstu2
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 Actor
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"actor": Learn more about the (Contract) actor FHIR attribute
Description: When this Contract was issued
FHIR Version: dstu2
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: Contract Valued Item
FHIR Version: dstu2
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: Contract Legal Language
FHIR Version: dstu2
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: "bindingAttachment" : { Attachment },
FHIR Version: dstu2
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: Contract Friendly Language
FHIR Version: dstu2
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 Subtype
FHIR Version: dstu2
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 Term List
FHIR Version: dstu2
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: Contract Action Reason
FHIR Version: dstu2
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: Effective time
FHIR Version: dstu2
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 Signer
FHIR Version: dstu2
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: dstu2
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 identifier
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Contract) identifier FHIR attribute
Description: Computable Contract Language
FHIR Version: dstu2
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: Contract Action
FHIR Version: dstu2
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: dstu2
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: Subject of this Contract
FHIR Version: dstu2
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
Contract Structure
{
"resourceType" : "Contract",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : { Identifier }, // Contract identifier
"issued" : "<dateTime>", // When this Contract was issued
"applies" : { Period }, // Effective time
"subject" : [{ Reference(Any) }], // Subject of this Contract
"authority" : [{ Reference(Organization) }], // Authority under which this Contract has standing
"domain" : [{ Reference(Location) }], // Domain in which this Contract applies
"type" : { CodeableConcept }, // Contract Tyoe
"subType" : [{ CodeableConcept }], // Contract Subtype
"action" : [{ CodeableConcept }], // Contract Action
"actionReason" : [{ CodeableConcept }], // Contract Action Reason
"actor" : [{ // Contract Actor
"entity" : { Reference(Contract|Device|Group|Location|Organization|Patient|
Practitioner|RelatedPerson|Substance) }, // R! Contract Actor Type
"role" : [{ CodeableConcept }] // Contract Actor Role
}],
"valuedItem" : [{ // Contract Valued Item
// entity[x]: Contract Valued Item Type. One of these 2:
"entityCodeableConcept" : { CodeableConcept },
"entityReference" : { Reference(Any) },
"identifier" : { Identifier }, // Contract Valued Item Identifier
"effectiveTime" : "<dateTime>", // Contract Valued Item Effective Tiem
"quantity" : { Quantity(SimpleQuantity) }, // Count of Contract Valued Items
"unitPrice" : { Quantity(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" : { Quantity(Money) } // Total Contract Valued Item Value
}],
"signer" : [{ // Contract Signer
"type" : { Coding }, // R! Contract Signer Type
"party" : { Reference(Organization|Patient|Practitioner|RelatedPerson) }, // R! Contract Signatory Party
"signature" : "<string>" // R! Contract Documentation Signature
}],
"term" : [{ // Contract Term List
"identifier" : { Identifier }, // Contract Term identifier
"issued" : "<dateTime>", // Contract Term Issue Date Time
"applies" : { Period }, // Contract Term Effective Time
"type" : { CodeableConcept }, // Contract Term Type
"subType" : { CodeableConcept }, // Contract Term Subtype
"subject" : { Reference(Any) }, // Subject of this Contract Term
"action" : [{ CodeableConcept }], // Contract Term Action
"actionReason" : [{ CodeableConcept }], // Contract Term Action Reason
"actor" : [{ // Contract Term Actor List
"entity" : { Reference(Contract|Device|Group|Location|Organization|
Patient|Practitioner|RelatedPerson|Substance) }, // R! Contract Term Actor
"role" : [{ CodeableConcept }] // Contract Term Actor Role
}],
"text" : "<string>", // Human readable Contract term text
"valuedItem" : [{ // Contract Term Valued Item
// entity[x]: Contract Term Valued Item Type. One of these 2:
"entityCodeableConcept" : { CodeableConcept },
"entityReference" : { Reference(Any) },
"identifier" : { Identifier }, // Contract Term Valued Item Identifier
"effectiveTime" : "<dateTime>", // Contract Term Valued Item Effective Tiem
"quantity" : { Quantity(SimpleQuantity) }, // Contract Term Valued Item Count
"unitPrice" : { Quantity(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" : { Quantity(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/dstu2/Contract?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
actor | reference | actor.entity |
identifier | text | identifier |
patient | reference | subject |
signer | reference | signer.party |
subject | reference | subject |
