contracts
Create Contract
post
/organizations/{organizationId}/fhir/4/Contract
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | This is a Contract resource | ||
| id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
| meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
| implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
| language | code | The base language in which the resource is written. | |
| text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
| contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
| extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| identifier | array(Identifier) | Unique identifier for this Contract or a derivative that references a Source Contract. | |
| url | uri | Canonical identifier for this contract, represented as a URI (globally unique). | |
| version | string | An edition identifier used for business purposes to label business significant variants. | |
| status | code | The status of the resource instance. | |
| legalState | CodeableConcept | Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement. | |
| instantiatesCanonical | Reference | The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. | |
| instantiatesUri | uri | The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. | |
| contentDerivative | CodeableConcept | The minimal content derived from the basal information source at a specific stage in its lifecycle. | |
| issued | dateTime | When this Contract was issued. | |
| applies | Period | Relevant time or time-period when this Contract is applicable. | |
| expirationType | CodeableConcept | Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. | |
| subject | array(Reference) | The target entity impacted by or of interest to parties to the 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. | |
| site | array(Reference) | Sites in which the contract is complied with, exercised, or in force. | |
| name | string | A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation. | |
| title | string | A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. | |
| subtitle | string | An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. | |
| alias | array(string) | Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation. | |
| author | Reference | The individual or organization that authored the Contract definition, derivative, or instance in any legal state. | |
| scope | CodeableConcept | A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. | |
| topicCodeableConcept | CodeableConcept | Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. | |
| topicReference | Reference | Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. | |
| type | CodeableConcept | A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract. | |
| subType | array(CodeableConcept) | Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope. | |
| contentDefinition | Contract_ContentDefinition | Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract. | |
| term | array(Contract_Term) | One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. | |
| supportingInfo | array(Reference) | Information that may be needed by/relevant to the performer in their execution of this term action. | |
| relevantHistory | array(Reference) | Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity. | |
| 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. | |
| 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. | |
| legallyBindingAttachment | 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. | |
| legallyBindingReference | 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. |
Response
keyboard_arrow_down
Patch Contract
patch
/organizations/{organizationId}/fhir/4/Contract/{resourceId}
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
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* | This is a Contract resource | ||
| id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
| meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
| implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
| language | code | The base language in which the resource is written. | |
| text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
| contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
| extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| identifier | array(Identifier) | Unique identifier for this Contract or a derivative that references a Source Contract. | |
| url | uri | Canonical identifier for this contract, represented as a URI (globally unique). | |
| version | string | An edition identifier used for business purposes to label business significant variants. | |
| status | code | The status of the resource instance. | |
| legalState | CodeableConcept | Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement. | |
| instantiatesCanonical | Reference | The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. | |
| instantiatesUri | uri | The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. | |
| contentDerivative | CodeableConcept | The minimal content derived from the basal information source at a specific stage in its lifecycle. | |
| issued | dateTime | When this Contract was issued. | |
| applies | Period | Relevant time or time-period when this Contract is applicable. | |
| expirationType | CodeableConcept | Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. | |
| subject | array(Reference) | The target entity impacted by or of interest to parties to the 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. | |
| site | array(Reference) | Sites in which the contract is complied with, exercised, or in force. | |
| name | string | A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation. | |
| title | string | A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. | |
| subtitle | string | An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. | |
| alias | array(string) | Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation. | |
| author | Reference | The individual or organization that authored the Contract definition, derivative, or instance in any legal state. | |
| scope | CodeableConcept | A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. | |
| topicCodeableConcept | CodeableConcept | Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. | |
| topicReference | Reference | Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. | |
| type | CodeableConcept | A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract. | |
| subType | array(CodeableConcept) | Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope. | |
| contentDefinition | Contract_ContentDefinition | Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract. | |
| term | array(Contract_Term) | One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. | |
| supportingInfo | array(Reference) | Information that may be needed by/relevant to the performer in their execution of this term action. | |
| relevantHistory | array(Reference) | Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity. | |
| 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. | |
| 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. | |
| legallyBindingAttachment | 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. | |
| legallyBindingReference | 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. |
Response
keyboard_arrow_down
Read Contract
get
/organizations/{organizationId}/fhir/4/Contract/{resourceId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | 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/4/Contract/{resourceId}/_history
Request
Headers
| content-type* | string | application/json|application/json+fhir | 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/4/Contract/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | 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/4/Contract/{resourceId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | 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/4/Contract
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| authority | string | ||
| domain | string | ||
| identifier | string | ||
| instantiates | string | ||
| issued | string | ||
| patient | string | ||
| signer | string | ||
| status | string | ||
| subject | string | ||
| url | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Contract
get
/organizations/{organizationId}/fhir/4/Contract/_history
Request
Headers
| content-type* | string | application/json|application/json+fhir | 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/4/Contract/_search
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
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 | ||
| authority | string | ||
| domain | string | ||
| identifier | string | ||
| instantiates | string | ||
| issued | string | ||
| patient | string | ||
| signer | string | ||
| status | string | ||
| subject | string | ||
| url | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | This is a Contract resource | ||
| id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
| meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
| implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
| language | code | The base language in which the resource is written. | |
| text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
| contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
| extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| identifier | array(Identifier) | Unique identifier for this Contract or a derivative that references a Source Contract. | |
| url | uri | Canonical identifier for this contract, represented as a URI (globally unique). | |
| version | string | An edition identifier used for business purposes to label business significant variants. | |
| status | code | The status of the resource instance. | |
| legalState | CodeableConcept | Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement. | |
| instantiatesCanonical | Reference | The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. | |
| instantiatesUri | uri | The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. | |
| contentDerivative | CodeableConcept | The minimal content derived from the basal information source at a specific stage in its lifecycle. | |
| issued | dateTime | When this Contract was issued. | |
| applies | Period | Relevant time or time-period when this Contract is applicable. | |
| expirationType | CodeableConcept | Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. | |
| subject | array(Reference) | The target entity impacted by or of interest to parties to the 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. | |
| site | array(Reference) | Sites in which the contract is complied with, exercised, or in force. | |
| name | string | A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation. | |
| title | string | A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. | |
| subtitle | string | An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. | |
| alias | array(string) | Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation. | |
| author | Reference | The individual or organization that authored the Contract definition, derivative, or instance in any legal state. | |
| scope | CodeableConcept | A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. | |
| topicCodeableConcept | CodeableConcept | Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. | |
| topicReference | Reference | Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. | |
| type | CodeableConcept | A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract. | |
| subType | array(CodeableConcept) | Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope. | |
| contentDefinition | Contract_ContentDefinition | Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract. | |
| term | array(Contract_Term) | One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. | |
| supportingInfo | array(Reference) | Information that may be needed by/relevant to the performer in their execution of this term action. | |
| relevantHistory | array(Reference) | Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity. | |
| 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. | |
| 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. | |
| legallyBindingAttachment | 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. | |
| legallyBindingReference | 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. |
Response
keyboard_arrow_down
Update Contract
put
/organizations/{organizationId}/fhir/4/Contract/{resourceId}
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Request
Headers
| content-type* | string | application/json|application/json+fhir | 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* | This is a Contract resource | ||
| id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
| meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
| implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
| language | code | The base language in which the resource is written. | |
| text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
| contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
| extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| identifier | array(Identifier) | Unique identifier for this Contract or a derivative that references a Source Contract. | |
| url | uri | Canonical identifier for this contract, represented as a URI (globally unique). | |
| version | string | An edition identifier used for business purposes to label business significant variants. | |
| status | code | The status of the resource instance. | |
| legalState | CodeableConcept | Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement. | |
| instantiatesCanonical | Reference | The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. | |
| instantiatesUri | uri | The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. | |
| contentDerivative | CodeableConcept | The minimal content derived from the basal information source at a specific stage in its lifecycle. | |
| issued | dateTime | When this Contract was issued. | |
| applies | Period | Relevant time or time-period when this Contract is applicable. | |
| expirationType | CodeableConcept | Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. | |
| subject | array(Reference) | The target entity impacted by or of interest to parties to the 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. | |
| site | array(Reference) | Sites in which the contract is complied with, exercised, or in force. | |
| name | string | A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation. | |
| title | string | A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. | |
| subtitle | string | An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. | |
| alias | array(string) | Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation. | |
| author | Reference | The individual or organization that authored the Contract definition, derivative, or instance in any legal state. | |
| scope | CodeableConcept | A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. | |
| topicCodeableConcept | CodeableConcept | Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. | |
| topicReference | Reference | Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. | |
| type | CodeableConcept | A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract. | |
| subType | array(CodeableConcept) | Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope. | |
| contentDefinition | Contract_ContentDefinition | Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract. | |
| term | array(Contract_Term) | One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. | |
| supportingInfo | array(Reference) | Information that may be needed by/relevant to the performer in their execution of this term action. | |
| relevantHistory | array(Reference) | Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity. | |
| 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. | |
| 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. | |
| legallyBindingAttachment | 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. | |
| legallyBindingReference | 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. |
Response
keyboard_arrow_down