Site identifier
HeyDonto FHIR R4 API - Financial (1.0)
The Financial module covers the resources and services provided by FHIR to support the costing, financial transactions and billing which occur within a healthcare provider as well as the eligibility, enrollment, authorizations, claims and payments which occur between healthcare providers and insurers and the reporting and notification between insurers and subscribers and patients.
See also the Administration and WorkFlow modules.
Resources:
- Account - A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
- Contract - Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement
- Coverage - Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment
- CoverageEligibilityRequest - Provides patient and insurance coverage information to an insurer for them to respond with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy
- CoverageEligibilityResponse - Provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource
- EnrollmentRequest - Provides the insurance enrollment details to the insurer regarding a specified coverage
- EnrollmentResponse - Provides enrollment and plan details from the processing of an EnrollmentRequest resource
- Claim - A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement
- ClaimResponse - Provides the adjudication details from the processing of a Claim resource
- PaymentNotice - Provides the status of the payment for goods and services rendered, and the request and response resource references
- PaymentReconciliation - Provides the details including amount of a payment and allocates the payment items being paid
- ExplanationOfBenefit - Provides the claim details, adjudication details from the processing of a Claim, and optionally account balance information, for informing the subscriber of the benefits provided
- VisionPrescription - An authorization for the provision of glasses and/or contact lenses to a patient
Image showing the relationship between the financial resources:
Additional Resources will be added in the future. A list of hypothesized resources can be found on the HL7 Confluence. Feel free to add any you think are missing or engage with one of the HL7 Work Groups to submit a proposal to define a resource of particular interest.
Financial information in general and in particular when related to or including health information, such as claims data, are typically considered Protected Health Information and as such must be afforded the same protection and safeguards as would be afforded to purely clinical identified health data.
The Security and Privacy measures associated with FHIR, such as the use of Security labels and tags in the resource.meta, are encouraged in addition to the use of whatever measures for authorization and encryption are supported by the chosen exchange model, e.g. FHIR REST, Web Services, Direct, MLLP, SMTP and others.
For more general considerations, see the Security and Privacy module.
The table below details various common business activities which occur in the financial realm, and the focal resources which may be exchanged, along with supporting resources, to accomplish the business activities. Whether the resources specified are actually needed requires consideration of the business itself and the exchange methodology and transport being used.
For example: If a content model is not required to obtain the appropriate status element then a SEARCH (GET) may be used, however if a content model is required to support the request for information then the content model will need to be CREATEd (POST). Alternately, if FHIR Operations are being used then the specified focal resource may be employed as one of the Operation parameters or might not be required.
| Business Activity | Request Resource | Response Resource |
|---|---|---|
| Eligibility Check | CoverageEligibilityRequest | CoverageEligibilityResponse |
| Enrollment Update | EnrollmentRequest | EnrollmentResponse |
| Claim | Claim (type={discipline}, use=claim) | ClaimResponse |
| Predetermination | Claim (type={discipline}, use=predetermination) | ClaimResponse |
| Preauthorization | Claim (type={discipline}, use=preauthorization) | ClaimResponse |
| Payment Notice | Task (code=deliver, input=PaymentNotice) | Task (output=error codes) |
| Payment Reconciliation | Task (code=poll, input=PaymentReconciliation) | Task (output=PaymentReconciliation) |
{discipline} means the type of claim: OralHealth, Vision, Pharmacy, Professional or Institutional.
See the Financial examples in Task for more details on Cancel, Nullify, Release, Reprocess, Status, and Poll operations.
Key financial terms and their definitions:
- Adjudication - The processing by an insurer of a claim, preauthorization or predetermination to determine under the insurance plan what if any benefits are or would be payable
- Beneficiary (Patient) - The party whose health care expenses may be covered by a policy issued by an Insurer
- Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any
- Coordination of Benefit (COB) - The rules, usually regionally defined, which govern the order of application of multiple Insurance coverages or Self-Pay to a given suite of health care expenses
- Insurer (Payer, Payor) - A public or private insurer which will adjudicate Claims for health care goods and services to determine if there is any benefit payable under the policy which covers the patient
- Policy - A contract between an Insurer and an individual or other entity such as an employer to reimburse covered parties (Beneficiaries) for some or all of a prescribed suite of health-related goods and services
- Preauthorization (Prior Authorization, Pre-Auth) - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted
- Predetermination (Pre-Determination, PreD) - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided
- Subscriber - The person who signs-up for the coverage. May be an employee or person with dependents
For the complete glossary, see the Financial Module documentation.
The table below details the relative order of events and use of financial resources for patient care during the care cycle. Not all steps or information exchanges may occur:
- Patient visits Provider
- Provider checks for valid insurance coverage (CoverageEligibilityRequest)
- Insurer responds with coverage status (CoverageEligibilityResponse)
- Provider examines Patient and reviews treatment options
- Provider submits Predetermination(s) for treatment options (Claim {use=predetermination})
- Insurer responds with potential reimbursement (ClaimResponse)
- Provider and Patient determine treatment plan
- Treatment plan submitted to Insurer to reserve funds (Claim {use=preauthorization})
- Provider provides treatment
- Provider submits patient's claim for reimbursement (Claim {use=claim})
- Insurer responds with claim adjudication (ClaimResponse)
- Patient leaves treatment setting
- Patient requests an Explanation of Benefit (ExplanationOfBenefit)
Resource Status Life-cycle: Financial resources begin with status 'draft' and continue with this status during development. When a resource is exchanged with an external party, the status changes to 'active'. An 'active' resource is immutable and cannot be edited except for status changes to 'cancel' or 'entered-in-error'.
Secondary Uses: In addition to their primary use of conveying patient billing information to insurers, many financial resources may be used to export data to other agencies to support reporting and analytics.
Attachments - Supporting Information: There is often a need to provide supporting information (attachments) to document the need for a service. This information may be provided inline in the resource's supportingInfo section, sent unsolicited in a Communication, or sent in response to a CommunicationRequest.
Subrogation: In some cases, it's not appropriate to send Claims to certain insurers due to jurisdictional rules. The Coverage resource supports marking coverages as subrogation to handle downstream recovery of costs.
Coordination of Benefit (COB): When a patient has multiple Coverages, there will be an agreed order of application of claims recovery. Claims work through the COB order until exhausted or no further balance remains.
Batches: eClaims request and response resources may be exchanged individually or via batches using Bundle resources.
Real-time Exchange: The eClaims resources are intended to support real-time exchange, though in many cases responses will only indicate receipt and validation, with deferred responses obtained later via REST or Poll operations.
The Financial Management Work Group (FM) is responsible for two subdomains:
- Financial Accounts and Billing (FIAB) - resources for accounts, charges (internal costing transactions) and patient billing
- Financial Claims and Reimbursement (FICR) - insurance information, enrollment, eligibility, predetermination, preauthorization, claims, patient reporting and payments
To date FM has been focusing on the resources required to support the exchange of claims and related information between health care providers and insurers. The first draft of this work is nearing completion with the first Financial Standard for Trial Use. Over the next year further refinements are expected as implementers begin developing regional profiles and begin live pilots with resources.
Once the above is well underway FM can then look to developing the Enrollment-related resources and the resources to support the FIAB functions.
In many cases an example valueset has been provided in this release. Financial Management will be devoting effort in the preparation to Release 5 of FHIR to develop more representative example sets and to determine where global codesets exist such that some of the valuesets may be elevated in strength to extensible or required.
Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/fhir/financial/
Sandbox
https://api-staging.heydonto.com/
Production
https://api.heydonto.com/
Query
Sort the results by a given field, e.g. _sort=family or _sort=-date.
Example: _sort=family
Restrict returned fields, e.g. _elements=identifier,name.
Example: _elements=identifier,name
Filter by resource telecom, e.g. date=[SYSTEM]|[VALUE].
Example: telecom=telecom=phone|555-555-5555
Search for resources by identifier token, e.g. identifier=http://hospital.org|12345.
Example: identifier=http://hospital.org|12345
Include related patient resources, e.g. patient=Patient/[id]&.
Example: patient=patient=Patient/[id]&
Reverse chaining, e.g. _has:Observation:subject:code=http://loinc.org|1234-5.
Example: _has=Observation:subject:code=http://loinc.org|1234-5
Search by tag on the resource meta, e.g. _tag=http://example.org/tags|sample-tag.
Example: _tag=http://example.org/tags|sample-tag
Search by security label on resource meta, e.g. _security=RBAC|CONFIDENTIAL.
Example: _security=RBAC|CONFIDENTIAL
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/contract
- Production
https://api.heydonto.com/site/{siteId}/fhir/contract
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract?_count=10&_page_token=CgYK...&_sort=family&_elements=identifier%2Cname&telecom=telecom%3Dphone%2C555-555-5555&_id=abc123&identifier=http%3A%2F%2Fhospital.org%2C12345&_include=string&patient=patient%3DPatient%2F%5Bid%5D%26&_revinclude=string&_has=Observation%3Asubject%3Acode%3Dhttp%3A%2F%2Floinc.org%2C1234-5&_tag=http%3A%2F%2Fexample.org%2Ftags%2Csample-tag&_security=RBAC%2CCONFIDENTIAL&_profile=http%3A%2F%2Fexample.org%2Ffhir%2FStructureDefinition%2Fcustom-profile' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Bodyapplication/json
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Indicates the purpose of this bundle - how it is intended to be used.
Enum"document""message""transaction""transaction-response""batch""batch-response""history""searchset""collection"
Example: "searchset"
An instant in time - known at least to the second
Example: "2024-01-01T00:00:00Z"
An integer with a value that is not negative (e.g. >= 0)
Example: 0
A series of links that provide context to this bundle.
Example: [{"relation":"search","url":"https://api.heydonto.com/fhir/contract/?_count=20"},{"relation":"next","url":"https://api.heydonto.com/fhir/contract/?_count=20&_page_token=TOKEN"},{"relation":"first","url":"https://api.heydonto.com/fhir/contract/?_count=20"},{"relation":"self","url":"https://api.heydonto.com/fhir/contract/?_count=20"}]
An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Example: [{"resourceType":"Contract","id":"C-123","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the contract</div>"},"identifier":[{"system":"http://happyvalley.com/contract","value":"12347"}],"term":[{"offer":{"text":"Can't refuse"},"asset":[{"type":[{"coding":[{"system":"urn:ietf:rfc:3986","code":"RicardianContract"}]}],"subtype":[{"text":"sample"}],"period":[{"start":"2017-06-01"}],"valuedItem":[{"entityCodeableConcept":{"text":"Ford Bobcat"},"identifier":{"system":"http://somewhere.motor-vehicle.com/vin","value":"XXSVT34-7665t952236"},"effectiveTime":"1995","quantity":{"value":1},"unitPrice":{"value":200,"currency":"CAD"},"factor":1,"points":1,"net":{"value":200,"currency":"CAD"}}]}]}],"rule":[{"contentAttachment":{"contentType":"application/txt","url":"http://www.rfc-editor.org/bcp/bcp13.txt"}}],"legallyBindingAttachment":{"contentType":"application/pdf","url":"http://www.aws3.com/storage/doc.pdf"}}]
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
Response
application/json
{ "resourceType": "Bundle", "type": "searchset", "total": 100, "link": [ { … }, { … }, { … }, { … } ], "entry": [ { … } ] }
Bodyapplication/jsonrequired
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(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.
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.
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).
Unique identifier for this Contract or a derivative that references a Source Contract.
Example: [{"system":"http://happyvalley.com/contract","value":"12347"}]
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
The target entity impacted by or of interest to parties to the agreement.
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.
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.
Sites in which the contract is complied with, exercised, or in force.
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.
Example: ["example-string"]
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
Example: [{"offer":{"text":"Can't refuse"},"asset":[{"type":[{"coding":[{"system":"urn:ietf:rfc:3986","code":"RicardianContract"}]}],"subtype":[{"text":"sample"}],"period":[{"start":"2017-06-01"}],"valuedItem":[{"entityCodeableConcept":{"text":"Ford Bobcat"},"identifier":{"system":"http://somewhere.motor-vehicle.com/vin","value":"XXSVT34-7665t952236"},"effectiveTime":"1995","quantity":{"value":1},"unitPrice":{"value":200,"currency":"CAD"},"factor":1,"points":1,"net":{"value":200,"currency":"CAD"}}]}]}]
Information that may be needed by/relevant to the performer in their execution of this term action.
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.
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.
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.
List of Computable Policy Rule Language Representations of this Contract.
Example: [{"contentAttachment":{"contentType":"application/txt","url":"http://www.rfc-editor.org/bcp/bcp13.txt"}}]
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/contract
- Production
https://api.heydonto.com/site/{siteId}/fhir/contract
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"resourceType": "Contract",
"id": "C-123",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the contract</div>"
},
"identifier": [
{
"system": "http://happyvalley.com/contract",
"value": "12347"
}
],
"term": [
{
"offer": {
"text": "Can'\''t refuse"
},
"asset": [
{
"type": [
{
"coding": [
{
"system": "urn:ietf:rfc:3986",
"code": "RicardianContract"
}
]
}
],
"subtype": [
{
"text": "sample"
}
],
"period": [
{
"start": "2017-06-01"
}
],
"valuedItem": [
{
"entityCodeableConcept": {
"text": "Ford Bobcat"
},
"identifier": {
"system": "http://somewhere.motor-vehicle.com/vin",
"value": "XXSVT34-7665t952236"
},
"effectiveTime": "1995",
"quantity": {
"value": 1
},
"unitPrice": {
"value": 200,
"currency": "CAD"
},
"factor": 1,
"points": 1,
"net": {
"value": 200,
"currency": "CAD"
}
}
]
}
]
}
],
"rule": [
{
"contentAttachment": {
"contentType": "application/txt",
"url": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
}
],
"legallyBindingAttachment": {
"contentType": "application/pdf",
"url": "http://www.aws3.com/storage/doc.pdf"
}
}'Bodyapplication/json
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(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.
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.
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).
Unique identifier for this Contract or a derivative that references a Source Contract.
Example: [{"system":"http://happyvalley.com/contract","value":"12347"}]
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
The target entity impacted by or of interest to parties to the agreement.
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.
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.
Sites in which the contract is complied with, exercised, or in force.
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.
Example: ["example-string"]
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
Example: [{"offer":{"text":"Can't refuse"},"asset":[{"type":[{"coding":[{"system":"urn:ietf:rfc:3986","code":"RicardianContract"}]}],"subtype":[{"text":"sample"}],"period":[{"start":"2017-06-01"}],"valuedItem":[{"entityCodeableConcept":{"text":"Ford Bobcat"},"identifier":{"system":"http://somewhere.motor-vehicle.com/vin","value":"XXSVT34-7665t952236"},"effectiveTime":"1995","quantity":{"value":1},"unitPrice":{"value":200,"currency":"CAD"},"factor":1,"points":1,"net":{"value":200,"currency":"CAD"}}]}]}]
Information that may be needed by/relevant to the performer in their execution of this term action.
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.
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.
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.
List of Computable Policy Rule Language Representations of this Contract.
Example: [{"contentAttachment":{"contentType":"application/txt","url":"http://www.rfc-editor.org/bcp/bcp13.txt"}}]
Response
application/json
{ "resourceType": "Contract", "id": "C-123", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the contract</div>" }, "identifier": [ { … } ], "term": [ { … } ], "rule": [ { … } ], "legallyBindingAttachment": { "contentType": "application/pdf", "url": "http://www.aws3.com/storage/doc.pdf" } }
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract/{id}
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/contract/{id}
- Production
https://api.heydonto.com/site/{siteId}/fhir/contract/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Bodyapplication/json
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(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.
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.
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).
Unique identifier for this Contract or a derivative that references a Source Contract.
Example: [{"system":"http://happyvalley.com/contract","value":"12347"}]
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
The target entity impacted by or of interest to parties to the agreement.
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.
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.
Sites in which the contract is complied with, exercised, or in force.
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.
Example: ["example-string"]
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
Example: [{"offer":{"text":"Can't refuse"},"asset":[{"type":[{"coding":[{"system":"urn:ietf:rfc:3986","code":"RicardianContract"}]}],"subtype":[{"text":"sample"}],"period":[{"start":"2017-06-01"}],"valuedItem":[{"entityCodeableConcept":{"text":"Ford Bobcat"},"identifier":{"system":"http://somewhere.motor-vehicle.com/vin","value":"XXSVT34-7665t952236"},"effectiveTime":"1995","quantity":{"value":1},"unitPrice":{"value":200,"currency":"CAD"},"factor":1,"points":1,"net":{"value":200,"currency":"CAD"}}]}]}]
Information that may be needed by/relevant to the performer in their execution of this term action.
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.
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.
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.
List of Computable Policy Rule Language Representations of this Contract.
Example: [{"contentAttachment":{"contentType":"application/txt","url":"http://www.rfc-editor.org/bcp/bcp13.txt"}}]
Response
application/json
{ "resourceType": "Contract", "id": "C-123", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the contract</div>" }, "identifier": [ { … } ], "term": [ { … } ], "rule": [ { … } ], "legallyBindingAttachment": { "contentType": "application/pdf", "url": "http://www.aws3.com/storage/doc.pdf" } }
Bodyapplication/jsonrequired
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(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.
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.
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).
Unique identifier for this Contract or a derivative that references a Source Contract.
Example: [{"system":"http://happyvalley.com/contract","value":"12347"}]
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
The target entity impacted by or of interest to parties to the agreement.
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.
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.
Sites in which the contract is complied with, exercised, or in force.
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.
Example: ["example-string"]
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
Example: [{"offer":{"text":"Can't refuse"},"asset":[{"type":[{"coding":[{"system":"urn:ietf:rfc:3986","code":"RicardianContract"}]}],"subtype":[{"text":"sample"}],"period":[{"start":"2017-06-01"}],"valuedItem":[{"entityCodeableConcept":{"text":"Ford Bobcat"},"identifier":{"system":"http://somewhere.motor-vehicle.com/vin","value":"XXSVT34-7665t952236"},"effectiveTime":"1995","quantity":{"value":1},"unitPrice":{"value":200,"currency":"CAD"},"factor":1,"points":1,"net":{"value":200,"currency":"CAD"}}]}]}]
Information that may be needed by/relevant to the performer in their execution of this term action.
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.
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.
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.
List of Computable Policy Rule Language Representations of this Contract.
Example: [{"contentAttachment":{"contentType":"application/txt","url":"http://www.rfc-editor.org/bcp/bcp13.txt"}}]
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract/{id}
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/contract/{id}
- Production
https://api.heydonto.com/site/{siteId}/fhir/contract/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"resourceType": "Contract",
"id": "C-123",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the contract</div>"
},
"identifier": [
{
"system": "http://happyvalley.com/contract",
"value": "12347"
}
],
"term": [
{
"offer": {
"text": "Can'\''t refuse"
},
"asset": [
{
"type": [
{
"coding": [
{
"system": "urn:ietf:rfc:3986",
"code": "RicardianContract"
}
]
}
],
"subtype": [
{
"text": "sample"
}
],
"period": [
{
"start": "2017-06-01"
}
],
"valuedItem": [
{
"entityCodeableConcept": {
"text": "Ford Bobcat"
},
"identifier": {
"system": "http://somewhere.motor-vehicle.com/vin",
"value": "XXSVT34-7665t952236"
},
"effectiveTime": "1995",
"quantity": {
"value": 1
},
"unitPrice": {
"value": 200,
"currency": "CAD"
},
"factor": 1,
"points": 1,
"net": {
"value": 200,
"currency": "CAD"
}
}
]
}
]
}
],
"rule": [
{
"contentAttachment": {
"contentType": "application/txt",
"url": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
}
],
"legallyBindingAttachment": {
"contentType": "application/pdf",
"url": "http://www.aws3.com/storage/doc.pdf"
}
}'Bodyapplication/json
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(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.
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.
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).
Unique identifier for this Contract or a derivative that references a Source Contract.
Example: [{"system":"http://happyvalley.com/contract","value":"12347"}]
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
The target entity impacted by or of interest to parties to the agreement.
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.
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.
Sites in which the contract is complied with, exercised, or in force.
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.
Example: ["example-string"]
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
Example: [{"offer":{"text":"Can't refuse"},"asset":[{"type":[{"coding":[{"system":"urn:ietf:rfc:3986","code":"RicardianContract"}]}],"subtype":[{"text":"sample"}],"period":[{"start":"2017-06-01"}],"valuedItem":[{"entityCodeableConcept":{"text":"Ford Bobcat"},"identifier":{"system":"http://somewhere.motor-vehicle.com/vin","value":"XXSVT34-7665t952236"},"effectiveTime":"1995","quantity":{"value":1},"unitPrice":{"value":200,"currency":"CAD"},"factor":1,"points":1,"net":{"value":200,"currency":"CAD"}}]}]}]
Information that may be needed by/relevant to the performer in their execution of this term action.
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.
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.
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.
List of Computable Policy Rule Language Representations of this Contract.
Example: [{"contentAttachment":{"contentType":"application/txt","url":"http://www.rfc-editor.org/bcp/bcp13.txt"}}]
Response
application/json
{ "resourceType": "Contract", "id": "C-123", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the contract</div>" }, "identifier": [ { … } ], "term": [ { … } ], "rule": [ { … } ], "legallyBindingAttachment": { "contentType": "application/pdf", "url": "http://www.aws3.com/storage/doc.pdf" } }
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract/{id}
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/contract/{id}
- Production
https://api.heydonto.com/site/{siteId}/fhir/contract/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "statusText": "OK", "status": 200 }
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract/{id}/history
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/contract/{id}/history
- Production
https://api.heydonto.com/site/{siteId}/fhir/contract/{id}/history
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/financial/site/{siteId}/fhir/contract/{id}/history' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "resourceType": "Bundle", "type": "history", "entry": [ { … } ], "total": 2 }