This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Financial Management Work Group | Maturity Level: 1 | Compartments: Not linked to any defined compartments |
A formal agreement between parties regarding the conduct of business, exchange of information or other matters.
The Contract resource is the basal resource to convey information of all manner of contracts for financial (e.g. Insurance policies), business arrangements (eg. supply contracts) and privacy and security (e.g. consent directives). Todo
This resource is referenced by Consent, Coverage and EligibilityResponse
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Contract | DomainResource | Contract | ||
identifier | Σ | 0..1 | Identifier | Contract identifier |
status | ?!Σ | 0..1 | code | active | cancelled | draft | entered-in-error Financial Resource Status Codes (Required) |
issued | Σ | 0..1 | dateTime | When this Contract was issued |
applies | Σ | 0..1 | Period | Effective time |
subject | Σ | 0..* | Reference(Any) | Contract Target Entity |
topic | Σ | 0..* | Reference(Any) | Context of the Contract |
authority | 0..* | Reference(Organization) | Authority under which this Contract has standing | |
domain | 0..* | Reference(Location) | Domain in which this Contract applies | |
type | Σ | 0..1 | CodeableConcept | Contract Type Contract Type Codes (Example) |
subType | Σ | 0..* | CodeableConcept | Contract Subtype Contract Subtype Codes (Example) |
action | 0..* | CodeableConcept | Contract Action Contract Action Codes (Example) | |
actionReason | 0..* | CodeableConcept | Contract Action Reason PurposeOfUse (Example) | |
agent | 0..* | BackboneElement | Contract Agent | |
actor | 1..1 | Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance) | Contract Agent Type | |
role | 0..* | CodeableConcept | Contract Agent Role Contract Actor Role Codes (Example) | |
signer | 0..* | BackboneElement | Contract Signer | |
type | 1..1 | Coding | Contract Signer Type Contract Signer Type Codes (Preferred) | |
party | 1..1 | Reference(Organization | Patient | Practitioner | RelatedPerson) | Contract Signatory Party | |
signature | 1..* | Signature | Contract Documentation Signature | |
valuedItem | 0..* | BackboneElement | Contract Valued Item | |
entity[x] | 0..1 | Contract Valued Item Type | ||
entityCodeableConcept | CodeableConcept | |||
entityReference | Reference(Any) | |||
identifier | 0..1 | Identifier | Contract Valued Item Identifier | |
effectiveTime | 0..1 | dateTime | Contract Valued Item Effective Tiem | |
quantity | 0..1 | SimpleQuantity | Count of Contract Valued Items | |
unitPrice | 0..1 | Money | Contract Valued Item fee, charge, or cost | |
factor | 0..1 | decimal | Contract Valued Item Price Scaling Factor | |
points | 0..1 | decimal | Contract Valued Item Difficulty Scaling Factor | |
net | 0..1 | Money | Total Contract Valued Item Value | |
term | 0..* | BackboneElement | Contract Term List | |
identifier | Σ | 0..1 | Identifier | Contract Term identifier |
issued | Σ | 0..1 | dateTime | Contract Term Issue Date Time |
applies | Σ | 0..1 | Period | Contract Term Effective Time |
type | 0..1 | CodeableConcept | Contract Term Type Contract Term Type Codes (Example) | |
subType | 0..1 | CodeableConcept | Contract Term Subtype Contract Term Type Codes (Example) | |
topic | Σ | 0..* | Reference(Any) | Context of the Contract term |
action | 0..* | CodeableConcept | Contract Term Action Contract Action Codes (Example) | |
actionReason | 0..* | CodeableConcept | Contract Term Action Reason PurposeOfUse (Example) | |
agent | 0..* | BackboneElement | Contract Term Agent List | |
actor | 1..1 | Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance) | Contract Term Agent List | |
role | 0..* | CodeableConcept | Contract Term Agent Role Contract Actor Role Codes (Example) | |
text | 0..1 | string | Human readable Contract term text | |
valuedItem | 0..* | BackboneElement | Contract Term Valued Item | |
entity[x] | 0..1 | Contract Term Valued Item Type | ||
entityCodeableConcept | CodeableConcept | |||
entityReference | Reference(Any) | |||
identifier | 0..1 | Identifier | Contract Term Valued Item Identifier | |
effectiveTime | 0..1 | dateTime | Contract Term Valued Item Effective Tiem | |
quantity | 0..1 | SimpleQuantity | Contract Term Valued Item Count | |
unitPrice | 0..1 | Money | Contract Term Valued Item fee, charge, or cost | |
factor | 0..1 | decimal | Contract Term Valued Item Price Scaling Factor | |
points | 0..1 | decimal | Contract Term Valued Item Difficulty Scaling Factor | |
net | 0..1 | Money | Total Contract Term Valued Item Value | |
group | 0..* | see term | Nested Contract Term Group | |
binding[x] | 0..1 | Binding Contract | ||
bindingAttachment | Attachment | |||
bindingReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | |||
friendly | 0..* | BackboneElement | Contract Friendly Language | |
content[x] | 1..1 | Easily comprehended representation of this Contract | ||
contentAttachment | Attachment | |||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | |||
legal | 0..* | BackboneElement | Contract Legal Language | |
content[x] | 1..1 | Contract Legal Text | ||
contentAttachment | Attachment | |||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | |||
rule | 0..* | BackboneElement | Computable Contract Language | |
content[x] | 1..1 | Computable Contract Rules | ||
contentAttachment | Attachment | |||
contentReference | Reference(DocumentReference) | |||
Documentation for this format |
UML Diagram (Legend)
XML Template
<Contract xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..1 Identifier Contract identifier --></identifier> <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error --> <issued value="[dateTime]"/><!-- 0..1 When this Contract was issued --> <applies><!-- 0..1 Period Effective time --></applies> <subject><!-- 0..* Reference(Any) Contract Target Entity --></subject> <topic><!-- 0..* Reference(Any) Context of the Contract --></topic> <authority><!-- 0..* Reference(Organization) Authority under which this Contract has standing --></authority> <domain><!-- 0..* Reference(Location) Domain in which this Contract applies --></domain> <type><!-- 0..1 CodeableConcept Contract Type --></type> <subType><!-- 0..* CodeableConcept Contract Subtype --></subType> <action><!-- 0..* CodeableConcept Contract Action --></action> <actionReason><!-- 0..* CodeableConcept Contract Action Reason --></actionReason> <agent> <!-- 0..* Contract Agent --> <actor><!-- 1..1 Reference(Contract|Device|Group|Location|Organization|Patient| Practitioner|RelatedPerson|Substance) Contract Agent Type --></actor> <role><!-- 0..* CodeableConcept Contract Agent Role --></role> </agent> <signer> <!-- 0..* Contract Signer --> <type><!-- 1..1 Coding Contract Signer Type --></type> <party><!-- 1..1 Reference(Organization|Patient|Practitioner|RelatedPerson) Contract Signatory Party --></party> <signature><!-- 1..* Signature Contract Documentation Signature --></signature> </signer> <valuedItem> <!-- 0..* Contract Valued Item --> <entity[x]><!-- 0..1 CodeableConcept|Reference(Any) Contract Valued Item Type --></entity[x]> <identifier><!-- 0..1 Identifier Contract Valued Item Identifier --></identifier> <effectiveTime value="[dateTime]"/><!-- 0..1 Contract Valued Item Effective Tiem --> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Contract Valued Items --></quantity> <unitPrice><!-- 0..1 Money Contract Valued Item fee, charge, or cost --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Contract Valued Item Price Scaling Factor --> <points value="[decimal]"/><!-- 0..1 Contract Valued Item Difficulty Scaling Factor --> <net><!-- 0..1 Money Total Contract Valued Item Value --></net> </valuedItem> <term> <!-- 0..* Contract Term List --> <identifier><!-- 0..1 Identifier Contract Term identifier --></identifier> <issued value="[dateTime]"/><!-- 0..1 Contract Term Issue Date Time --> <applies><!-- 0..1 Period Contract Term Effective Time --></applies> <type><!-- 0..1 CodeableConcept Contract Term Type --></type> <subType><!-- 0..1 CodeableConcept Contract Term Subtype --></subType> <topic><!-- 0..* Reference(Any) Context of the Contract term --></topic> <action><!-- 0..* CodeableConcept Contract Term Action --></action> <actionReason><!-- 0..* CodeableConcept Contract Term Action Reason --></actionReason> <agent> <!-- 0..* Contract Term Agent List --> <actor><!-- 1..1 Reference(Contract|Device|Group|Location|Organization|Patient| Practitioner|RelatedPerson|Substance) Contract Term Agent List --></actor> <role><!-- 0..* CodeableConcept Contract Term Agent Role --></role> </agent> <text value="[string]"/><!-- 0..1 Human readable Contract term text --> <valuedItem> <!-- 0..* Contract Term Valued Item --> <entity[x]><!-- 0..1 CodeableConcept|Reference(Any) Contract Term Valued Item Type --></entity[x]> <identifier><!-- 0..1 Identifier Contract Term Valued Item Identifier --></identifier> <effectiveTime value="[dateTime]"/><!-- 0..1 Contract Term Valued Item Effective Tiem --> <quantity><!-- 0..1 Quantity(SimpleQuantity) Contract Term Valued Item Count --></quantity> <unitPrice><!-- 0..1 Money Contract Term Valued Item fee, charge, or cost --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Contract Term Valued Item Price Scaling Factor --> <points value="[decimal]"/><!-- 0..1 Contract Term Valued Item Difficulty Scaling Factor --> <net><!-- 0..1 Money Total Contract Term Valued Item Value --></net> </valuedItem> <group><!-- 0..* Content as for Contract.term Nested Contract Term Group --></group> </term> <binding[x]><!-- 0..1 Attachment|Reference(Composition|DocumentReference| QuestionnaireResponse) Binding Contract --></binding[x]> <friendly> <!-- 0..* Contract Friendly Language --> <content[x]><!-- 1..1 Attachment|Reference(Composition|DocumentReference| QuestionnaireResponse) Easily comprehended representation of this Contract --></content[x]> </friendly> <legal> <!-- 0..* Contract Legal Language --> <content[x]><!-- 1..1 Attachment|Reference(Composition|DocumentReference| QuestionnaireResponse) Contract Legal Text --></content[x]> </legal> <rule> <!-- 0..* Computable Contract Language --> <content[x]><!-- 1..1 Attachment|Reference(DocumentReference) Computable Contract Rules --></content[x]> </rule> </Contract>
JSON Template
{ "resourceType" : "Contract", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : { Identifier }, // Contract identifier "status" : "<code>", // active | cancelled | draft | entered-in-error "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 }, // Contract Type "subType" : [{ CodeableConcept }], // Contract Subtype "action" : [{ CodeableConcept }], // Contract Action "actionReason" : [{ CodeableConcept }], // Contract Action Reason "agent" : [{ // Contract Agent "actor" : { Reference(Contract|Device|Group|Location|Organization|Patient| Practitioner|RelatedPerson|Substance) }, // R! Contract Agent Type "role" : [{ CodeableConcept }] // Contract Agent Role }], "signer" : [{ // Contract Signer "type" : { Coding }, // R! Contract Signer Type "party" : { Reference(Organization|Patient|Practitioner|RelatedPerson) }, // R! Contract Signatory Party "signature" : [{ Signature }] // R! Contract Documentation Signature }], "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" : { 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 identifier "issued" : "<dateTime>", // Contract Term Issue Date Time "applies" : { Period }, // Contract Term Effective Time "type" : { CodeableConcept }, // Contract Term Type "subType" : { CodeableConcept }, // Contract Term Subtype "topic" : [{ Reference(Any) }], // Context of the Contract term "action" : [{ CodeableConcept }], // Contract Term Action "actionReason" : [{ CodeableConcept }], // Contract Term Action Reason "agent" : [{ // Contract Term Agent List "actor" : { Reference(Contract|Device|Group|Location|Organization|Patient| Practitioner|RelatedPerson|Substance) }, // R! Contract Term Agent List "role" : [{ CodeableConcept }] // Contract Term Agent 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" : { 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) } }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Contract; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Contract.identifier [ Identifier ]; # 0..1 Contract identifier fhir:Contract.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error fhir:Contract.issued [ dateTime ]; # 0..1 When this Contract was issued fhir:Contract.applies [ Period ]; # 0..1 Effective time fhir:Contract.subject [ Reference(Any) ], ... ; # 0..* Contract Target Entity fhir:Contract.topic [ Reference(Any) ], ... ; # 0..* Context of the Contract fhir:Contract.authority [ Reference(Organization) ], ... ; # 0..* Authority under which this Contract has standing fhir:Contract.domain [ Reference(Location) ], ... ; # 0..* Domain in which this Contract applies fhir:Contract.type [ CodeableConcept ]; # 0..1 Contract Type fhir:Contract.subType [ CodeableConcept ], ... ; # 0..* Contract Subtype fhir:Contract.action [ CodeableConcept ], ... ; # 0..* Contract Action fhir:Contract.actionReason [ CodeableConcept ], ... ; # 0..* Contract Action Reason fhir:Contract.agent [ # 0..* Contract Agent fhir:Contract.agent.actor [ Reference(Contract|Device|Group|Location|Organization|Patient|Practitioner|RelatedPerson| Substance) ]; # 1..1 Contract Agent Type fhir:Contract.agent.role [ CodeableConcept ], ... ; # 0..* Contract Agent Role ], ...; fhir:Contract.signer [ # 0..* Contract Signer fhir:Contract.signer.type [ Coding ]; # 1..1 Contract Signer Type fhir:Contract.signer.party [ Reference(Organization|Patient|Practitioner|RelatedPerson) ]; # 1..1 Contract Signatory Party fhir:Contract.signer.signature [ Signature ], ... ; # 1..* Contract Documentation Signature ], ...; fhir:Contract.valuedItem [ # 0..* Contract Valued Item # Contract.valuedItem.entity[x] : 0..1 Contract Valued Item Type. One of these 2 fhir:Contract.valuedItem.entityCodeableConcept [ CodeableConcept ] fhir:Contract.valuedItem.entityReference [ Reference(Any) ] fhir:Contract.valuedItem.identifier [ Identifier ]; # 0..1 Contract Valued Item Identifier fhir:Contract.valuedItem.effectiveTime [ dateTime ]; # 0..1 Contract Valued Item Effective Tiem fhir:Contract.valuedItem.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Contract Valued Items fhir:Contract.valuedItem.unitPrice [ Money ]; # 0..1 Contract Valued Item fee, charge, or cost fhir:Contract.valuedItem.factor [ decimal ]; # 0..1 Contract Valued Item Price Scaling Factor fhir:Contract.valuedItem.points [ decimal ]; # 0..1 Contract Valued Item Difficulty Scaling Factor fhir:Contract.valuedItem.net [ Money ]; # 0..1 Total Contract Valued Item Value ], ...; fhir:Contract.term [ # 0..* Contract Term List fhir:Contract.term.identifier [ Identifier ]; # 0..1 Contract Term identifier fhir:Contract.term.issued [ dateTime ]; # 0..1 Contract Term Issue Date Time fhir:Contract.term.applies [ Period ]; # 0..1 Contract Term Effective Time fhir:Contract.term.type [ CodeableConcept ]; # 0..1 Contract Term Type fhir:Contract.term.subType [ CodeableConcept ]; # 0..1 Contract Term Subtype fhir:Contract.term.topic [ Reference(Any) ], ... ; # 0..* Context of the Contract term fhir:Contract.term.action [ CodeableConcept ], ... ; # 0..* Contract Term Action fhir:Contract.term.actionReason [ CodeableConcept ], ... ; # 0..* Contract Term Action Reason fhir:Contract.term.agent [ # 0..* Contract Term Agent List fhir:Contract.term.agent.actor [ Reference(Contract|Device|Group|Location|Organization|Patient|Practitioner|RelatedPerson| Substance) ]; # 1..1 Contract Term Agent List fhir:Contract.term.agent.role [ CodeableConcept ], ... ; # 0..* Contract Term Agent Role ], ...; fhir:Contract.term.text [ string ]; # 0..1 Human readable Contract term text fhir:Contract.term.valuedItem [ # 0..* Contract Term Valued Item # Contract.term.valuedItem.entity[x] : 0..1 Contract Term Valued Item Type. One of these 2 fhir:Contract.term.valuedItem.entityCodeableConcept [ CodeableConcept ] fhir:Contract.term.valuedItem.entityReference [ Reference(Any) ] fhir:Contract.term.valuedItem.identifier [ Identifier ]; # 0..1 Contract Term Valued Item Identifier fhir:Contract.term.valuedItem.effectiveTime [ dateTime ]; # 0..1 Contract Term Valued Item Effective Tiem fhir:Contract.term.valuedItem.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Contract Term Valued Item Count fhir:Contract.term.valuedItem.unitPrice [ Money ]; # 0..1 Contract Term Valued Item fee, charge, or cost fhir:Contract.term.valuedItem.factor [ decimal ]; # 0..1 Contract Term Valued Item Price Scaling Factor fhir:Contract.term.valuedItem.points [ decimal ]; # 0..1 Contract Term Valued Item Difficulty Scaling Factor fhir:Contract.term.valuedItem.net [ Money ]; # 0..1 Total Contract Term Valued Item Value ], ...; fhir:Contract.term.group [ See Contract.term ], ... ; # 0..* Nested Contract Term Group ], ...; # Contract.binding[x] : 0..1 Binding Contract. One of these 2 fhir:Contract.bindingAttachment [ Attachment ] fhir:Contract.bindingReference [ Reference(Composition|DocumentReference|QuestionnaireResponse) ] fhir:Contract.friendly [ # 0..* Contract Friendly Language # Contract.friendly.content[x] : 1..1 Easily comprehended representation of this Contract. One of these 2 fhir:Contract.friendly.contentAttachment [ Attachment ] fhir:Contract.friendly.contentReference [ Reference(Composition|DocumentReference|QuestionnaireResponse) ] ], ...; fhir:Contract.legal [ # 0..* Contract Legal Language # Contract.legal.content[x] : 1..1 Contract Legal Text. One of these 2 fhir:Contract.legal.contentAttachment [ Attachment ] fhir:Contract.legal.contentReference [ Reference(Composition|DocumentReference|QuestionnaireResponse) ] ], ...; fhir:Contract.rule [ # 0..* Computable Contract Language # Contract.rule.content[x] : 1..1 Computable Contract Rules. One of these 2 fhir:Contract.rule.contentAttachment [ Attachment ] fhir:Contract.rule.contentReference [ Reference(DocumentReference) ] ], ...; ]
Changes since DSTU2
Contract | |
Contract.status | added Element |
Contract.topic | added Element |
Contract.agent | added Element |
Contract.agent.actor | added Element |
Contract.agent.role | added Element |
Contract.signer.signature |
Max Cardinality changed from 1 to * Type changed from string to Signature |
Contract.valuedItem.unitPrice | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Contract.valuedItem.net | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Contract.term.topic | added Element |
Contract.term.agent | added Element |
Contract.term.agent.actor | added Element |
Contract.term.agent.role | added Element |
Contract.term.valuedItem.unitPrice | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Contract.term.valuedItem.net | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Contract.actor | deleted |
Contract.term.subject | deleted |
Contract.term.actor | deleted |
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Contract | DomainResource | Contract | ||
identifier | Σ | 0..1 | Identifier | Contract identifier |
status | ?!Σ | 0..1 | code | active | cancelled | draft | entered-in-error Financial Resource Status Codes (Required) |
issued | Σ | 0..1 | dateTime | When this Contract was issued |
applies | Σ | 0..1 | Period | Effective time |
subject | Σ | 0..* | Reference(Any) | Contract Target Entity |
topic | Σ | 0..* | Reference(Any) | Context of the Contract |
authority | 0..* | Reference(Organization) | Authority under which this Contract has standing | |
domain | 0..* | Reference(Location) | Domain in which this Contract applies | |
type | Σ | 0..1 | CodeableConcept | Contract Type Contract Type Codes (Example) |
subType | Σ | 0..* | CodeableConcept | Contract Subtype Contract Subtype Codes (Example) |
action | 0..* | CodeableConcept | Contract Action Contract Action Codes (Example) | |
actionReason | 0..* | CodeableConcept | Contract Action Reason PurposeOfUse (Example) | |
agent | 0..* | BackboneElement | Contract Agent | |
actor | 1..1 | Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance) | Contract Agent Type | |
role | 0..* | CodeableConcept | Contract Agent Role Contract Actor Role Codes (Example) | |
signer | 0..* | BackboneElement | Contract Signer | |
type | 1..1 | Coding | Contract Signer Type Contract Signer Type Codes (Preferred) | |
party | 1..1 | Reference(Organization | Patient | Practitioner | RelatedPerson) | Contract Signatory Party | |
signature | 1..* | Signature | Contract Documentation Signature | |
valuedItem | 0..* | BackboneElement | Contract Valued Item | |
entity[x] | 0..1 | Contract Valued Item Type | ||
entityCodeableConcept | CodeableConcept | |||
entityReference | Reference(Any) | |||
identifier | 0..1 | Identifier | Contract Valued Item Identifier | |
effectiveTime | 0..1 | dateTime | Contract Valued Item Effective Tiem | |
quantity | 0..1 | SimpleQuantity | Count of Contract Valued Items | |
unitPrice | 0..1 | Money | Contract Valued Item fee, charge, or cost | |
factor | 0..1 | decimal | Contract Valued Item Price Scaling Factor | |
points | 0..1 | decimal | Contract Valued Item Difficulty Scaling Factor | |
net | 0..1 | Money | Total Contract Valued Item Value | |
term | 0..* | BackboneElement | Contract Term List | |
identifier | Σ | 0..1 | Identifier | Contract Term identifier |
issued | Σ | 0..1 | dateTime | Contract Term Issue Date Time |
applies | Σ | 0..1 | Period | Contract Term Effective Time |
type | 0..1 | CodeableConcept | Contract Term Type Contract Term Type Codes (Example) | |
subType | 0..1 | CodeableConcept | Contract Term Subtype Contract Term Type Codes (Example) | |
topic | Σ | 0..* | Reference(Any) | Context of the Contract term |
action | 0..* | CodeableConcept | Contract Term Action Contract Action Codes (Example) | |
actionReason | 0..* | CodeableConcept | Contract Term Action Reason PurposeOfUse (Example) | |
agent | 0..* | BackboneElement | Contract Term Agent List | |
actor | 1..1 | Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance) | Contract Term Agent List | |
role | 0..* | CodeableConcept | Contract Term Agent Role Contract Actor Role Codes (Example) | |
text | 0..1 | string | Human readable Contract term text | |
valuedItem | 0..* | BackboneElement | Contract Term Valued Item | |
entity[x] | 0..1 | Contract Term Valued Item Type | ||
entityCodeableConcept | CodeableConcept | |||
entityReference | Reference(Any) | |||
identifier | 0..1 | Identifier | Contract Term Valued Item Identifier | |
effectiveTime | 0..1 | dateTime | Contract Term Valued Item Effective Tiem | |
quantity | 0..1 | SimpleQuantity | Contract Term Valued Item Count | |
unitPrice | 0..1 | Money | Contract Term Valued Item fee, charge, or cost | |
factor | 0..1 | decimal | Contract Term Valued Item Price Scaling Factor | |
points | 0..1 | decimal | Contract Term Valued Item Difficulty Scaling Factor | |
net | 0..1 | Money | Total Contract Term Valued Item Value | |
group | 0..* | see term | Nested Contract Term Group | |
binding[x] | 0..1 | Binding Contract | ||
bindingAttachment | Attachment | |||
bindingReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | |||
friendly | 0..* | BackboneElement | Contract Friendly Language | |
content[x] | 1..1 | Easily comprehended representation of this Contract | ||
contentAttachment | Attachment | |||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | |||
legal | 0..* | BackboneElement | Contract Legal Language | |
content[x] | 1..1 | Contract Legal Text | ||
contentAttachment | Attachment | |||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | |||
rule | 0..* | BackboneElement | Computable Contract Language | |
content[x] | 1..1 | Computable Contract Rules | ||
contentAttachment | Attachment | |||
contentReference | Reference(DocumentReference) | |||
Documentation for this format |
XML Template
<Contract xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..1 Identifier Contract identifier --></identifier> <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error --> <issued value="[dateTime]"/><!-- 0..1 When this Contract was issued --> <applies><!-- 0..1 Period Effective time --></applies> <subject><!-- 0..* Reference(Any) Contract Target Entity --></subject> <topic><!-- 0..* Reference(Any) Context of the Contract --></topic> <authority><!-- 0..* Reference(Organization) Authority under which this Contract has standing --></authority> <domain><!-- 0..* Reference(Location) Domain in which this Contract applies --></domain> <type><!-- 0..1 CodeableConcept Contract Type --></type> <subType><!-- 0..* CodeableConcept Contract Subtype --></subType> <action><!-- 0..* CodeableConcept Contract Action --></action> <actionReason><!-- 0..* CodeableConcept Contract Action Reason --></actionReason> <agent> <!-- 0..* Contract Agent --> <actor><!-- 1..1 Reference(Contract|Device|Group|Location|Organization|Patient| Practitioner|RelatedPerson|Substance) Contract Agent Type --></actor> <role><!-- 0..* CodeableConcept Contract Agent Role --></role> </agent> <signer> <!-- 0..* Contract Signer --> <type><!-- 1..1 Coding Contract Signer Type --></type> <party><!-- 1..1 Reference(Organization|Patient|Practitioner|RelatedPerson) Contract Signatory Party --></party> <signature><!-- 1..* Signature Contract Documentation Signature --></signature> </signer> <valuedItem> <!-- 0..* Contract Valued Item --> <entity[x]><!-- 0..1 CodeableConcept|Reference(Any) Contract Valued Item Type --></entity[x]> <identifier><!-- 0..1 Identifier Contract Valued Item Identifier --></identifier> <effectiveTime value="[dateTime]"/><!-- 0..1 Contract Valued Item Effective Tiem --> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Contract Valued Items --></quantity> <unitPrice><!-- 0..1 Money Contract Valued Item fee, charge, or cost --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Contract Valued Item Price Scaling Factor --> <points value="[decimal]"/><!-- 0..1 Contract Valued Item Difficulty Scaling Factor --> <net><!-- 0..1 Money Total Contract Valued Item Value --></net> </valuedItem> <term> <!-- 0..* Contract Term List --> <identifier><!-- 0..1 Identifier Contract Term identifier --></identifier> <issued value="[dateTime]"/><!-- 0..1 Contract Term Issue Date Time --> <applies><!-- 0..1 Period Contract Term Effective Time --></applies> <type><!-- 0..1 CodeableConcept Contract Term Type --></type> <subType><!-- 0..1 CodeableConcept Contract Term Subtype --></subType> <topic><!-- 0..* Reference(Any) Context of the Contract term --></topic> <action><!-- 0..* CodeableConcept Contract Term Action --></action> <actionReason><!-- 0..* CodeableConcept Contract Term Action Reason --></actionReason> <agent> <!-- 0..* Contract Term Agent List --> <actor><!-- 1..1 Reference(Contract|Device|Group|Location|Organization|Patient| Practitioner|RelatedPerson|Substance) Contract Term Agent List --></actor> <role><!-- 0..* CodeableConcept Contract Term Agent Role --></role> </agent> <text value="[string]"/><!-- 0..1 Human readable Contract term text --> <valuedItem> <!-- 0..* Contract Term Valued Item --> <entity[x]><!-- 0..1 CodeableConcept|Reference(Any) Contract Term Valued Item Type --></entity[x]> <identifier><!-- 0..1 Identifier Contract Term Valued Item Identifier --></identifier> <effectiveTime value="[dateTime]"/><!-- 0..1 Contract Term Valued Item Effective Tiem --> <quantity><!-- 0..1 Quantity(SimpleQuantity) Contract Term Valued Item Count --></quantity> <unitPrice><!-- 0..1 Money Contract Term Valued Item fee, charge, or cost --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Contract Term Valued Item Price Scaling Factor --> <points value="[decimal]"/><!-- 0..1 Contract Term Valued Item Difficulty Scaling Factor --> <net><!-- 0..1 Money Total Contract Term Valued Item Value --></net> </valuedItem> <group><!-- 0..* Content as for Contract.term Nested Contract Term Group --></group> </term> <binding[x]><!-- 0..1 Attachment|Reference(Composition|DocumentReference| QuestionnaireResponse) Binding Contract --></binding[x]> <friendly> <!-- 0..* Contract Friendly Language --> <content[x]><!-- 1..1 Attachment|Reference(Composition|DocumentReference| QuestionnaireResponse) Easily comprehended representation of this Contract --></content[x]> </friendly> <legal> <!-- 0..* Contract Legal Language --> <content[x]><!-- 1..1 Attachment|Reference(Composition|DocumentReference| QuestionnaireResponse) Contract Legal Text --></content[x]> </legal> <rule> <!-- 0..* Computable Contract Language --> <content[x]><!-- 1..1 Attachment|Reference(DocumentReference) Computable Contract Rules --></content[x]> </rule> </Contract>
JSON Template
{ "resourceType" : "Contract", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : { Identifier }, // Contract identifier "status" : "<code>", // active | cancelled | draft | entered-in-error "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 }, // Contract Type "subType" : [{ CodeableConcept }], // Contract Subtype "action" : [{ CodeableConcept }], // Contract Action "actionReason" : [{ CodeableConcept }], // Contract Action Reason "agent" : [{ // Contract Agent "actor" : { Reference(Contract|Device|Group|Location|Organization|Patient| Practitioner|RelatedPerson|Substance) }, // R! Contract Agent Type "role" : [{ CodeableConcept }] // Contract Agent Role }], "signer" : [{ // Contract Signer "type" : { Coding }, // R! Contract Signer Type "party" : { Reference(Organization|Patient|Practitioner|RelatedPerson) }, // R! Contract Signatory Party "signature" : [{ Signature }] // R! Contract Documentation Signature }], "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" : { 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 identifier "issued" : "<dateTime>", // Contract Term Issue Date Time "applies" : { Period }, // Contract Term Effective Time "type" : { CodeableConcept }, // Contract Term Type "subType" : { CodeableConcept }, // Contract Term Subtype "topic" : [{ Reference(Any) }], // Context of the Contract term "action" : [{ CodeableConcept }], // Contract Term Action "actionReason" : [{ CodeableConcept }], // Contract Term Action Reason "agent" : [{ // Contract Term Agent List "actor" : { Reference(Contract|Device|Group|Location|Organization|Patient| Practitioner|RelatedPerson|Substance) }, // R! Contract Term Agent List "role" : [{ CodeableConcept }] // Contract Term Agent 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" : { 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) } }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Contract; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Contract.identifier [ Identifier ]; # 0..1 Contract identifier fhir:Contract.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error fhir:Contract.issued [ dateTime ]; # 0..1 When this Contract was issued fhir:Contract.applies [ Period ]; # 0..1 Effective time fhir:Contract.subject [ Reference(Any) ], ... ; # 0..* Contract Target Entity fhir:Contract.topic [ Reference(Any) ], ... ; # 0..* Context of the Contract fhir:Contract.authority [ Reference(Organization) ], ... ; # 0..* Authority under which this Contract has standing fhir:Contract.domain [ Reference(Location) ], ... ; # 0..* Domain in which this Contract applies fhir:Contract.type [ CodeableConcept ]; # 0..1 Contract Type fhir:Contract.subType [ CodeableConcept ], ... ; # 0..* Contract Subtype fhir:Contract.action [ CodeableConcept ], ... ; # 0..* Contract Action fhir:Contract.actionReason [ CodeableConcept ], ... ; # 0..* Contract Action Reason fhir:Contract.agent [ # 0..* Contract Agent fhir:Contract.agent.actor [ Reference(Contract|Device|Group|Location|Organization|Patient|Practitioner|RelatedPerson| Substance) ]; # 1..1 Contract Agent Type fhir:Contract.agent.role [ CodeableConcept ], ... ; # 0..* Contract Agent Role ], ...; fhir:Contract.signer [ # 0..* Contract Signer fhir:Contract.signer.type [ Coding ]; # 1..1 Contract Signer Type fhir:Contract.signer.party [ Reference(Organization|Patient|Practitioner|RelatedPerson) ]; # 1..1 Contract Signatory Party fhir:Contract.signer.signature [ Signature ], ... ; # 1..* Contract Documentation Signature ], ...; fhir:Contract.valuedItem [ # 0..* Contract Valued Item # Contract.valuedItem.entity[x] : 0..1 Contract Valued Item Type. One of these 2 fhir:Contract.valuedItem.entityCodeableConcept [ CodeableConcept ] fhir:Contract.valuedItem.entityReference [ Reference(Any) ] fhir:Contract.valuedItem.identifier [ Identifier ]; # 0..1 Contract Valued Item Identifier fhir:Contract.valuedItem.effectiveTime [ dateTime ]; # 0..1 Contract Valued Item Effective Tiem fhir:Contract.valuedItem.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Contract Valued Items fhir:Contract.valuedItem.unitPrice [ Money ]; # 0..1 Contract Valued Item fee, charge, or cost fhir:Contract.valuedItem.factor [ decimal ]; # 0..1 Contract Valued Item Price Scaling Factor fhir:Contract.valuedItem.points [ decimal ]; # 0..1 Contract Valued Item Difficulty Scaling Factor fhir:Contract.valuedItem.net [ Money ]; # 0..1 Total Contract Valued Item Value ], ...; fhir:Contract.term [ # 0..* Contract Term List fhir:Contract.term.identifier [ Identifier ]; # 0..1 Contract Term identifier fhir:Contract.term.issued [ dateTime ]; # 0..1 Contract Term Issue Date Time fhir:Contract.term.applies [ Period ]; # 0..1 Contract Term Effective Time fhir:Contract.term.type [ CodeableConcept ]; # 0..1 Contract Term Type fhir:Contract.term.subType [ CodeableConcept ]; # 0..1 Contract Term Subtype fhir:Contract.term.topic [ Reference(Any) ], ... ; # 0..* Context of the Contract term fhir:Contract.term.action [ CodeableConcept ], ... ; # 0..* Contract Term Action fhir:Contract.term.actionReason [ CodeableConcept ], ... ; # 0..* Contract Term Action Reason fhir:Contract.term.agent [ # 0..* Contract Term Agent List fhir:Contract.term.agent.actor [ Reference(Contract|Device|Group|Location|Organization|Patient|Practitioner|RelatedPerson| Substance) ]; # 1..1 Contract Term Agent List fhir:Contract.term.agent.role [ CodeableConcept ], ... ; # 0..* Contract Term Agent Role ], ...; fhir:Contract.term.text [ string ]; # 0..1 Human readable Contract term text fhir:Contract.term.valuedItem [ # 0..* Contract Term Valued Item # Contract.term.valuedItem.entity[x] : 0..1 Contract Term Valued Item Type. One of these 2 fhir:Contract.term.valuedItem.entityCodeableConcept [ CodeableConcept ] fhir:Contract.term.valuedItem.entityReference [ Reference(Any) ] fhir:Contract.term.valuedItem.identifier [ Identifier ]; # 0..1 Contract Term Valued Item Identifier fhir:Contract.term.valuedItem.effectiveTime [ dateTime ]; # 0..1 Contract Term Valued Item Effective Tiem fhir:Contract.term.valuedItem.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Contract Term Valued Item Count fhir:Contract.term.valuedItem.unitPrice [ Money ]; # 0..1 Contract Term Valued Item fee, charge, or cost fhir:Contract.term.valuedItem.factor [ decimal ]; # 0..1 Contract Term Valued Item Price Scaling Factor fhir:Contract.term.valuedItem.points [ decimal ]; # 0..1 Contract Term Valued Item Difficulty Scaling Factor fhir:Contract.term.valuedItem.net [ Money ]; # 0..1 Total Contract Term Valued Item Value ], ...; fhir:Contract.term.group [ See Contract.term ], ... ; # 0..* Nested Contract Term Group ], ...; # Contract.binding[x] : 0..1 Binding Contract. One of these 2 fhir:Contract.bindingAttachment [ Attachment ] fhir:Contract.bindingReference [ Reference(Composition|DocumentReference|QuestionnaireResponse) ] fhir:Contract.friendly [ # 0..* Contract Friendly Language # Contract.friendly.content[x] : 1..1 Easily comprehended representation of this Contract. One of these 2 fhir:Contract.friendly.contentAttachment [ Attachment ] fhir:Contract.friendly.contentReference [ Reference(Composition|DocumentReference|QuestionnaireResponse) ] ], ...; fhir:Contract.legal [ # 0..* Contract Legal Language # Contract.legal.content[x] : 1..1 Contract Legal Text. One of these 2 fhir:Contract.legal.contentAttachment [ Attachment ] fhir:Contract.legal.contentReference [ Reference(Composition|DocumentReference|QuestionnaireResponse) ] ], ...; fhir:Contract.rule [ # 0..* Computable Contract Language # Contract.rule.content[x] : 1..1 Computable Contract Rules. One of these 2 fhir:Contract.rule.contentAttachment [ Attachment ] fhir:Contract.rule.contentReference [ Reference(DocumentReference) ] ], ...; ]
Changes since DSTU2
Contract | |
Contract.status | added Element |
Contract.topic | added Element |
Contract.agent | added Element |
Contract.agent.actor | added Element |
Contract.agent.role | added Element |
Contract.signer.signature |
Max Cardinality changed from 1 to * Type changed from string to Signature |
Contract.valuedItem.unitPrice | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Contract.valuedItem.net | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Contract.term.topic | added Element |
Contract.term.agent | added Element |
Contract.term.agent.actor | added Element |
Contract.term.agent.role | added Element |
Contract.term.valuedItem.unitPrice | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Contract.term.valuedItem.net | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Contract.actor | deleted |
Contract.term.subject | deleted |
Contract.term.actor | deleted |
See the Full Difference for further information
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),
Path | Definition | Type | Reference |
---|---|---|---|
Contract.status | A code specifying the state of the resource instance. | Required | Financial Resource Status Codes |
Contract.type | List of overall contract codes. | Example | Contract Type Codes |
Contract.subType | Detailed codes within the above. | Example | Contract Subtype Codes |
Contract.action Contract.term.action | Detailed codes for the contract action. | Example | Contract Action Codes |
Contract.actionReason Contract.term.actionReason | Detailed codes for the contract action reason. | Example | PurposeOfUse |
Contract.agent.role Contract.term.agent.role | Detailed codes for the contract actor role. | Example | Contract Actor Role Codes |
Contract.signer.type | List of parties who may be signing. | Preferred | Contract Signer Type Codes |
Contract.term.type | Detailed codes for the types of contract provisions. | Example | Contract Term Type Codes |
Contract.term.subType | Detailed codes for the subtypes of contract provisions. | Example | Contract Term Type Codes |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths | In Common |
agent | reference | Agent to the Contact | Contract.agent.actor (Practitioner, Group, Organization, Device, Patient, Substance, Contract, RelatedPerson, Location) | |
authority | reference | The authority of the contract | Contract.authority (Organization) | |
domain | reference | The domain of the contract | Contract.domain (Location) | |
identifier | token | The identity of the contract | Contract.identifier | |
issued | date | The date/time the contract was issued | Contract.issued | |
patient | reference | The identity of the subject of the contract (if a patient) | Contract.subject (Patient) | |
signer | reference | Contract Signatory Party | Contract.signer.party (Practitioner, Organization, Patient, RelatedPerson) | |
subject | reference | The identity of the subject of the contract | Contract.subject (Any) | |
topic | reference | The identity of the topic of the contract | Contract.topic (Any) | |
ttopic | reference | The identity of the topic of the contract terms | Contract.term.topic (Any) |