Contract - FHIR Resource (dstu2)
This Contract Resource uses the
FHIR API standard for access and structure.
Validate an Contract FHIR Resource (dstu2)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
action | true | CodeableConcept | # Contract Action
|
actionReason | true | CodeableConcept | # Contract Action Reason
|
actor | true | Data Type | # Contract Actor
|
applies | false | Period | # Effective time
|
authority | true | Reference | # Authority under which this Contract has standing
|
bindingAttachment | false | Attachment | # "bindingAttachment" : { Attachment },
|
bindingReference | false | Reference | # "bindingReference" : { Reference(Composition|DocumentReference|
|
domain | true | Reference | # Domain in which this Contract applies
|
friendly | true | Data Type | # Contract Friendly Language
|
identifier | false | Identifier | # Contract identifier
|
issued | false | dateTime | # When this Contract was issued
|
legal | true | Data Type | # Contract Legal Language
|
rule | true | Data Type | # Computable Contract Language
|
signer | true | Data Type | # Contract Signer
|
subType | true | CodeableConcept | # Contract Subtype
|
subject | true | Reference | # Subject of this Contract
|
term | true | Data Type | # Contract Term List
|
type | false | CodeableConcept | # Contract Tyoe
|
valuedItem | true | Data Type | # Contract Valued Item
|
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 |