contracts
Create Contract
post
/organizations/{organizationId}/fhir/3/Contract
A formal agreement between parties regarding the conduct of business, exchange of information or other matters.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Contract | This is a Contract resource |
| identifier | Identifier | Unique identifier for this Contract. | |
| status | string | The status of the resource instance. | |
| issued | string | When this Contract was issued. | |
| applies | Period | Relevant time or time-period when this Contract is applicable. | |
| subject | array(Reference) | The target entity impacted by or of interest to parties to the agreement. | |
| topic | array(Reference) | The matter of concern in the context of this agreement. | |
| authority | array(Reference) | A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies. | |
| domain | array(Reference) | Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources. | |
| type | CodeableConcept | Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc. | |
| subType | array(CodeableConcept) | More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent. | |
| action | array(CodeableConcept) | Action stipulated by this Contract. | |
| actionReason | array(CodeableConcept) | Reason for action stipulated by this Contract. | |
| decisionType | CodeableConcept | The type of decision made by a grantor with respect to an offer made by a grantee. | |
| contentDerivative | CodeableConcept | The minimal content derived from the basal information source at a specific stage in its lifecycle. | |
| securityLabel | array(Coding) | A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels. | |
| agent | array(Contract_Agent) | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. | |
| signer | array(Contract_Signer) | Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness. | |
| valuedItem | array(Contract_ValuedItem) | Contract Valued Item List. | |
| term | array(Contract_Term) | One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. | |
| bindingAttachment | Attachment | Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract. | |
| bindingReference | Reference | Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract. | |
| friendly | array(Contract_Friendly) | The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement. | |
| legal | array(Contract_Legal) | List of Legal expressions or representations of this Contract. | |
| rule | array(Contract_Rule) | List of Computable Policy Rule Language Representations of this Contract. |
Response
keyboard_arrow_down
Patch Contract
patch
/organizations/{organizationId}/fhir/3/Contract/{resourceId}
A formal agreement between parties regarding the conduct of business, exchange of information or other matters.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Contract | This is a Contract resource |
| identifier | Identifier | Unique identifier for this Contract. | |
| status | string | The status of the resource instance. | |
| issued | string | When this Contract was issued. | |
| applies | Period | Relevant time or time-period when this Contract is applicable. | |
| subject | array(Reference) | The target entity impacted by or of interest to parties to the agreement. | |
| topic | array(Reference) | The matter of concern in the context of this agreement. | |
| authority | array(Reference) | A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies. | |
| domain | array(Reference) | Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources. | |
| type | CodeableConcept | Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc. | |
| subType | array(CodeableConcept) | More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent. | |
| action | array(CodeableConcept) | Action stipulated by this Contract. | |
| actionReason | array(CodeableConcept) | Reason for action stipulated by this Contract. | |
| decisionType | CodeableConcept | The type of decision made by a grantor with respect to an offer made by a grantee. | |
| contentDerivative | CodeableConcept | The minimal content derived from the basal information source at a specific stage in its lifecycle. | |
| securityLabel | array(Coding) | A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels. | |
| agent | array(Contract_Agent) | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. | |
| signer | array(Contract_Signer) | Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness. | |
| valuedItem | array(Contract_ValuedItem) | Contract Valued Item List. | |
| term | array(Contract_Term) | One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. | |
| bindingAttachment | Attachment | Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract. | |
| bindingReference | Reference | Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract. | |
| friendly | array(Contract_Friendly) | The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement. | |
| legal | array(Contract_Legal) | List of Legal expressions or representations of this Contract. | |
| rule | array(Contract_Rule) | List of Computable Policy Rule Language Representations of this Contract. |
Response
keyboard_arrow_down
Read Contract
get
/organizations/{organizationId}/fhir/3/Contract/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Contract
get
/organizations/{organizationId}/fhir/3/Contract/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Contract
get
/organizations/{organizationId}/fhir/3/Contract/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Contract
delete
/organizations/{organizationId}/fhir/3/Contract/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Contract
get
/organizations/{organizationId}/fhir/3/Contract
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| agent | string | ||
| authority | string | ||
| domain | string | ||
| identifier | string | ||
| issued | string | ||
| patient | string | ||
| signer | string | ||
| subject | string | ||
| term-topic | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Contract
get
/organizations/{organizationId}/fhir/3/Contract/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Contract
post
/organizations/{organizationId}/fhir/3/Contract/_search
A formal agreement between parties regarding the conduct of business, exchange of information or other matters.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| agent | string | ||
| authority | string | ||
| domain | string | ||
| identifier | string | ||
| issued | string | ||
| patient | string | ||
| signer | string | ||
| subject | string | ||
| term-topic | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Contract | This is a Contract resource |
| identifier | Identifier | Unique identifier for this Contract. | |
| status | string | The status of the resource instance. | |
| issued | string | When this Contract was issued. | |
| applies | Period | Relevant time or time-period when this Contract is applicable. | |
| subject | array(Reference) | The target entity impacted by or of interest to parties to the agreement. | |
| topic | array(Reference) | The matter of concern in the context of this agreement. | |
| authority | array(Reference) | A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies. | |
| domain | array(Reference) | Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources. | |
| type | CodeableConcept | Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc. | |
| subType | array(CodeableConcept) | More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent. | |
| action | array(CodeableConcept) | Action stipulated by this Contract. | |
| actionReason | array(CodeableConcept) | Reason for action stipulated by this Contract. | |
| decisionType | CodeableConcept | The type of decision made by a grantor with respect to an offer made by a grantee. | |
| contentDerivative | CodeableConcept | The minimal content derived from the basal information source at a specific stage in its lifecycle. | |
| securityLabel | array(Coding) | A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels. | |
| agent | array(Contract_Agent) | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. | |
| signer | array(Contract_Signer) | Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness. | |
| valuedItem | array(Contract_ValuedItem) | Contract Valued Item List. | |
| term | array(Contract_Term) | One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. | |
| bindingAttachment | Attachment | Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract. | |
| bindingReference | Reference | Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract. | |
| friendly | array(Contract_Friendly) | The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement. | |
| legal | array(Contract_Legal) | List of Legal expressions or representations of this Contract. | |
| rule | array(Contract_Rule) | List of Computable Policy Rule Language Representations of this Contract. |
Response
keyboard_arrow_down
Update Contract
put
/organizations/{organizationId}/fhir/3/Contract/{resourceId}
A formal agreement between parties regarding the conduct of business, exchange of information or other matters.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Contract | This is a Contract resource |
| identifier | Identifier | Unique identifier for this Contract. | |
| status | string | The status of the resource instance. | |
| issued | string | When this Contract was issued. | |
| applies | Period | Relevant time or time-period when this Contract is applicable. | |
| subject | array(Reference) | The target entity impacted by or of interest to parties to the agreement. | |
| topic | array(Reference) | The matter of concern in the context of this agreement. | |
| authority | array(Reference) | A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies. | |
| domain | array(Reference) | Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources. | |
| type | CodeableConcept | Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc. | |
| subType | array(CodeableConcept) | More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent. | |
| action | array(CodeableConcept) | Action stipulated by this Contract. | |
| actionReason | array(CodeableConcept) | Reason for action stipulated by this Contract. | |
| decisionType | CodeableConcept | The type of decision made by a grantor with respect to an offer made by a grantee. | |
| contentDerivative | CodeableConcept | The minimal content derived from the basal information source at a specific stage in its lifecycle. | |
| securityLabel | array(Coding) | A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels. | |
| agent | array(Contract_Agent) | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. | |
| signer | array(Contract_Signer) | Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness. | |
| valuedItem | array(Contract_ValuedItem) | Contract Valued Item List. | |
| term | array(Contract_Term) | One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. | |
| bindingAttachment | Attachment | Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract. | |
| bindingReference | Reference | Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract. | |
| friendly | array(Contract_Friendly) | The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement. | |
| legal | array(Contract_Legal) | List of Legal expressions or representations of this Contract. | |
| rule | array(Contract_Rule) | List of Computable Policy Rule Language Representations of this Contract. |
Response
keyboard_arrow_down