Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm
2.0.0 - STU2
Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm
2.0.0 - STU2
Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm, published by HL7 International / Human and Social Services. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/eLTSS/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/eltss/StructureDefinition/Contract-eltss | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: Contract_eltss | ||
Contract for eLTSS
The following aids in finding the location of eLTSS data elements. See R4 FHIR Mapping page for complete guidance, here we are providing a subset of fields for convenience.
| eLTSS Grouping | eLTSS Data Element Name | Data Element Definition (includes examples, expected list of values and usage note where applicable) | FHIR R4 Resource Element(s) | FHIR R4 Resource Element Cardinality (with US Core Constraints) | Additional Mapping Details |
|---|---|---|---|---|---|
| Plan Signatures | Person Signature | The depiction of the person's signature as proof of identity and intent for the plan. | CarePlan → supportingInfo(Contract) Contract → signer → type Contract → signer → signature → data Contract → signer → signature → type Contract → signer → signature → who(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........type 1 .........signature 1..* ............data 0..1 ............type 1 ............who(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) Can use a single Contract element to contain all signatures. 3) signer requires the signature and a type that indicates the contract signatory role. 4) FHIR includes a preferred coding for contract signatory roles, which map well to the eLTSS signatories. The primary one for the patient/beneficiary is "PAT" (patient), although implementers may use others as well. However, implementers must realize that type may be used to differentiate between the patient, service provider, planner, etc. so there need to be distinct role types utilized. 5) data is the actual signature content (XML DigSig. JWT, picture, etc.) 6) signature requires it's own type element that indicates why the entity signed the contract, and FHIR provides a preferred code list. Would probably use "1.2.840.10065.1.12.1.7" which represents "consent signature" in this case. 7) signature requires a who to indicate who signed, which can be a Patient, Organization, Practitioner, PrationerRole, RelatedPerson or Device, although in this case it would be the Patient. |
| Plan Signatures | Person Printed Name | The printed or typed name of the person. | CarePlan → supportingInfo(Contract) Contract → signer → party(Patient) |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........party(Patient) 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) In this case, party is a reference to the Patient, and Patient is already documented above to include a name. |
| Plan Signatures | Person Signature Date | The date the person signed the plan. | CarePlan → supportingInfo(Contract) Contract → signer → signature → when |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........signature 1..* ............when 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) when is required by FHIR, and indicates when the signature was created. 3) when is an instance type. An instant in time - known at least to the second and always includes a time zone. Note: This is intended for precisely observed times (typically system logs etc.), and not human-reported times - for them, use date and dateTime. instant is a more constrained dateTime. |
| Plan Signatures | Guardian / Legal Representative Signature | The depiction of the guardian or legally authorized representative's signature as proof of identity and intent for the plan. | CarePlan → supportingInfo(Contract) Contract → signer → type Contract → signer → signature → data Contract → signer → signature → type Contract → signer → signature → who(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........type 1 .........signature 1..* ............data 0..1 ............type 1 ............who(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) Can use a single Contract element to contain all signatures. 3) signer requires the signature and a type that indicates the contract signatory role. 4) FHIR includes a preferred coding for contract signatory roles, which map well to the eLTSS signatories. There are multiple values that may be used depending on how states want to map. For example, the list includes: "POWATT" (power of attorney), "GUARD" (guardian), "HPOWATT" (healthcare power of attorney), etc. However, implementers must realize that type may be used to differentiate between the patient, service provider, planner, etc. so there need to be distinct role types utilized. 5) data is the signature content (XML DigSig. JWT, picture, etc.) 6) signature requires it's own type element that indicates why the entity signed the contract, and FHIR provides a preferred value set. Would probably use "1.2.840.10065.1.12.1.7" which represents "consent signature" in this case. 7) signature requires a who to indicate who signed, which can be a Patient, Organization, Practitioner, PractitionerRole, RelatedPerson or Device although in this case it would be the RelatedPerson. |
| Plan Signatures | Guardian / Legal Representative Printed Name | The printed or typed name of the guardian or legally authorized representative. | CarePlan → supportingInfo(Contract) Contract → signer → party(RelatedPerson) |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........party(RelatedPerson) 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) In this case, party is a reference to a RelatedPerson, and RelatedPatient includes a name. |
| Plan Signatures | Guardian / Legal Representative Signature Date | The date the guardian or legally authorized representative signed the plan. | CarePlan → supportingInfo(Contract) Contract → signer → signature → when |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........signature 1..* ............when 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) when is required by FHIR, and indicates when the signature was created. 3) when is an instance type. An instant in time - known at least to the second and always includes a time zone. Note: This is intended for precisely observed times (typically system logs etc.), and not human-reported times - for them, use date and dateTime. instant is a more constrained dateTime. |
| Plan Signatures | Support Planner Signature | The depiction of the support planner's signature as proof of identity and intent for the plan. | CarePlan → supportingInfo(Contract) Contract → signer → type Contract → signer → signature → data Contract → signer → signature → type Contract → signer → signature → who(Practitioner | PractitionerRole | Organization RelatedPerson | Patient | Organization) |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........type 1 .........signature 1..* ............data 0..1 ............type 1 ............who(Practitioner |PractitionerRole | Organization RelatedPerson | Patient | Organization) 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) Can use a single Contract element to contain all signatures. 3) signer requires the signature and a type that indicates the contract signatory role. 4) FHIR includes a preferred coding for contract signatory roles, which map well to the eLTSS signatories. There are multiple values that may be used depending on how states want to map. For example, the list includes "AUT" (author) which aligns with author being the support planner for other eLTSS Dataset elements. However other role types may be appropriate as well such as "GUAR" (guarantor). However, implementers must realize that type may be used to differentiate between the patient, service provider, planner, etc. so there need to be distinct role types utilized. 5) data is the actual signature content (XML DigSig. JWT, picture, etc.) 6) signature requires it's own type element that indicates why the entity signed the contract, and FHIR provides a preferred value set, in this case could use "1.2.840.10065.1.12.1.1" for "Author's Signature". 7) signature requires a who to indicate who signed, which can be a Patient, Organization, Practitioner, PractitionerRole, RelatedPerson or Device. |
| Plan Signatures | Support Planner Printed Name | The printed or typed name of the support planner. | CarePlan → supportingInfo(Contract) Contract → signer → party(Practitioner|PractitionerRole|Organization) |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........party(Practitioner|PractitionerRole|Organization) |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) In this case, party is a reference to a Practitioner, PractitionerRole or Organization (for cases when the Organization of the SupportPlanner is needed), and Practitioner and Organization includes a name. 3) The values for Support Planner Name and Support Planner Printed Name would include the same information. |
| Plan Signatures | Support Planner Signature Date | The date the support planner signed the plan. | CarePlan → supportingInfo(Contract) Contract → signer → signature → when |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........signature 1..* ............when 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) when is required by FHIR, and indicates when the signature was created. 3) when is an instance type. An instant in time - known at least to the second and always includes a time zone. Note: This is intended for precisely observed times (typically system logs etc.), and not human-reported times - for them, use date and dateTime. instant is a more constrained dateTime. |
| Plan Signatures | Service Provider Signature | The depiction of the service provider's signature as proof they agree to the services they will provide. | CarePlan → supportingInfo(Contract) Contract → signer → type Contract → signer → signature → data Contract → signer → signature → type Contract → signer → signature → who(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........type 1 .........signature 1..* ............data 0..1 ............type 1 ............who(Practitioner |PractitionerRole | RelatedPerson | Patient | Device | Organization) 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) Can use a single Contract element to contain all signatures. 3) signer requires the signature and a type that indicates the contract signatory role. 4) FHIR includes a preferred coding for contract signer roles, which map well to the eLTSS signatories. There are multiple values that may be used depending on how states want to map. The list includes "HPROV" (healthcare provider) which may be the best fit here, although others may be applicable. However, implementers must realize that type may be used to differentiate between the patient, service provider, planner, etc. so there need to be distinct role types utilized. 5) data is the actual signature content (XML DigSig. JWT, picture, etc.) 6) signature requires it's own type element that indicates why the entity signed the contract, and FHIR provides a preferred value set. In this case would probably use "1.2.840.10065.1.12.1.3" for "Co-participant's Signature". 7) signature requires a who to indicate who signed, which can be a Patient, Organization, Practitioner, PractitionerRole, RelatedPerson or Device. |
| Plan Signatures | Service Provider Printed Name | The printed or typed name of the service provider. | CarePlan → supportingInfo(Contract) Contract → signer → party(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........party(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) party is a reference to an Organization, Patient, Practitioner, PractitionerRole or RelatedPerson, all of which include a name. (Patient may not make sense in the context of a service provided by a care plan, but is allowed in FHIR.) 3) The values for Service Provider Name and Service Provider Printed Name would include the same information. |
| Plan Signatures | Service Provider Signature Date | The date the service provider signed the plan. | CarePlan → supportingInfo(Contract) Contract → signer → signature → when |
CarePlan ...supportingInfo(Contract) 0..* ......signer 0..* .........signature 1..* ............when 1 |
1) Will use CarePlan → supportingInfo to reference the Contract containing the signatures, names, etc. 2) when is required by FHIR, and indicates when the signature was created. 3) when is an instance type. An instant in time - known at least to the second and always includes a time zone. Note: This is intended for precisely observed times (typically system logs etc.), and not human-reported times - for them, use date and dateTime. instant is a more constrained dateTime. |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Contract
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Contract |
0..* | Contract | Legal Agreement | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by type:url | |
   resource-pertainsToGoal |
S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 0..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance. |
 instantiatesCanonical |
0..1 | Reference(Contract_eltss) | Source Contract Definition | |
| domain |
0..* | Reference(Location_eltss) | A sphere of control governed by an authoritative jurisdiction, organization, or person | |
| site |
0..* | Reference(Location_eltss) | Specific Location | |
| author |
0..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | US Core Organization Profile) | Source of Contract | |
 term |
0..* | BackboneElement | Contract Term List | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 offer |
1..1 | BackboneElement | Context of the Contract term | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| party |
0..* | BackboneElement | Offer Recipient | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reference |
1..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | Group | US Core Organization Profile) | Referenced entity | |
 role |
1..1 | CodeableConcept | Participant engagement type Binding: ContractResourcePartyRoleCodes (example): Codes for offer participant roles. | |
| signer |
S | 0..* | BackboneElement | Person, Guardian / Legal Representative, Support Planner, or Service Provider Signature |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
S | 1..1 | Coding | Contract Signatory Role Binding: ContractSignerTypeCodes (preferred): List of parties who may be signing. |
| party |
S | 1..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile) | Person, Guardian / Legal Representative, Support Planner, or Service Provider Printed Name |
| signature |
S | 1..* | Signature | Contract Documentation Signature |
| type |
SΣ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. |
| when |
SΣ | 1..1 | instant | Person, Guardian / Legal Representative, Support Planner, or Service Provider Signature Date |
| who |
SΣ | 1..1 | Reference(eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile | Practitioner_eltss | Patient_eltss) | Person, Guardian/Legal Representative, Support Planner, or Service Provider Printed Name |
| data |
S | 0..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) |
| rule |
0..* | BackboneElement | Computable Contract Language | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 content[x] |
1..1 | Computable Contract Rule(s) | ||
| contentAttachment |
Attachment | |||
| contentReference |
Reference(DocumentReference) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1from the FHIR Standard | |
| Contract.term.offer.party.role | example | ContractResourcePartyRoleCodeshttp://hl7.org/fhir/ValueSet/contract-party-rolefrom the FHIR Standard | |
| Contract.signer.type | preferred | ContractSignerTypeCodeshttp://hl7.org/fhir/ValueSet/contract-signer-typefrom the FHIR Standard | |
| Contract.signer.signature.type | preferred | SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Contract | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Contract | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Contract | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Contract |
0..* | Contract | Legal Agreement | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by type:url | |||||
| resource-pertainsToGoal |
S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Contract number | ||||
| url |
0..1 | uri | Basal definition | |||||
| version |
Σ | 0..1 | string | Business edition | ||||
| status |
?!Σ | 0..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
| legalState |
0..1 | CodeableConcept | Negotiation status Binding: ContractResourceLegalStateCodes (extensible): Detailed codes for the legal state of a contract. | |||||
| instantiatesCanonical |
0..1 | Reference(Contract_eltss) | Source Contract Definition | |||||
| instantiatesUri |
0..1 | uri | External Contract Definition | |||||
| contentDerivative |
0..1 | CodeableConcept | Content derived from the basal information Binding: ContractContentDerivationCodes (example): This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source. | |||||
| issued |
Σ | 0..1 | dateTime | When this Contract was issued | ||||
| applies |
Σ | 0..1 | Period | Effective time | ||||
| expirationType |
0..1 | CodeableConcept | Contract cessation cause Binding: ContractResourceExpirationTypeCodes (example): Codes for the Cessation of Contracts. | |||||
| subject |
Σ | 0..* | Reference(Resource) | Contract Target Entity | ||||
| authority |
0..* | Reference(Organization) | Authority under which this Contract has standing | |||||
| domain |
0..* | Reference(Location_eltss) | A sphere of control governed by an authoritative jurisdiction, organization, or person | |||||
| site |
0..* | Reference(Location_eltss) | Specific Location | |||||
| name |
Σ | 0..1 | string | Computer friendly designation | ||||
| title |
Σ | 0..1 | string | Human Friendly name | ||||
| subtitle |
0..1 | string | Subordinate Friendly name | |||||
| alias |
0..* | string | Acronym or short name | |||||
| author |
0..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | US Core Organization Profile) | Source of Contract | |||||
| scope |
0..1 | CodeableConcept | Range of Legal Concerns Binding: ContractResourceScopeCodes (example): Codes for the range of legal concerns. | |||||
| topic[x] |
0..1 | Focus of contract interest | ||||||
| topicCodeableConcept |
CodeableConcept | |||||||
| topicReference |
Reference(Resource) | |||||||
| type |
Σ | 0..1 | CodeableConcept | Legal instrument category Binding: ContractTypeCodes (example): List of overall contract codes. | ||||
| subType |
Σ | 0..* | CodeableConcept | Subtype within the context of type Binding: ContractSubtypeCodes (example): Detailed codes within the above. | ||||
| contentDefinition |
0..1 | BackboneElement | Contract precursor content | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Content structure and use Binding: ContractResourceDefinitionTypeCodes (example): Detailed codes for the definition of contracts. | |||||
| subType |
0..1 | CodeableConcept | Detailed Content Type Definition Binding: ContractResourceDefinitionSubtypeCodes (example): Detailed codes for the additional definition of contracts. | |||||
| publisher |
0..1 | Reference(Practitioner_eltss | eLTSS PractitionerRole Profile | US Core Organization Profile) | Publisher Entity | |||||
| publicationDate |
0..1 | dateTime | When published | |||||
| publicationStatus |
1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourcePublicationStatusCodes (required): Status of the publication of contract content. | |||||
| copyright |
0..1 | markdown | Publication Ownership | |||||
| term |
0..* | BackboneElement | Contract Term List | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
Σ | 0..1 | Identifier | Contract Term Number | ||||
| issued |
Σ | 0..1 | dateTime | Contract Term Issue Date Time | ||||
| applies |
Σ | 0..1 | Period | Contract Term Effective Time | ||||
| topic[x] |
0..1 | Term Concern | ||||||
| topicCodeableConcept |
CodeableConcept | |||||||
| topicReference |
Reference(Resource) | |||||||
| type |
0..1 | CodeableConcept | Contract Term Type or Form Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions. | |||||
| subType |
0..1 | CodeableConcept | Contract Term Type specific classification Binding: ContractTermSubtypeCodes (example): Detailed codes for the subtypes of contract provisions. | |||||
| text |
Σ | 0..1 | string | Term Statement | ||||
| securityLabel |
0..* | BackboneElement | Protection for the Term | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| number |
0..* | unsignedInt | Link to Security Labels | |||||
| classification |
1..1 | Coding | Confidentiality Protection Binding: ContractResourceScopeCodes (example): Codes for confidentiality protection. | |||||
| category |
0..* | Coding | Applicable Policy Binding: ContractResourceScopeCodes (example): Codes for policy category. | |||||
| control |
0..* | Coding | Handling Instructions Binding: ContractResourceSecurityControlCodes (example): Codes for handling instructions. | |||||
| offer |
1..1 | BackboneElement | Context of the Contract term | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | Offer business ID | |||||
| party |
0..* | BackboneElement | Offer Recipient | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| reference |
1..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | Group | US Core Organization Profile) | Referenced entity | |||||
| role |
1..1 | CodeableConcept | Participant engagement type Binding: ContractResourcePartyRoleCodes (example): Codes for offer participant roles. | |||||
| topic |
Σ | 0..1 | Reference(Resource) | Negotiable offer asset | ||||
| type |
0..1 | CodeableConcept | Contract Offer Type or Form Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions. | |||||
| decision |
0..1 | CodeableConcept | Accepting party choice Binding: ActConsentDirective (extensible): The type of decision made by a grantor with respect to an offer made by a grantee. | |||||
| decisionMode |
0..* | CodeableConcept | How decision is conveyed Binding: ContractResourceDecisionModeCodes (example): Codes for conveying a decision. | |||||
| answer |
0..* | BackboneElement | Response to offer text | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] |
1..1 | The actual answer response | ||||||
| valueBoolean |
boolean | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueUri |
uri | |||||||
| valueAttachment |
Attachment | |||||||
| valueCoding |
Coding | |||||||
| valueQuantity |
Quantity | |||||||
| valueReference |
Reference(Resource) | |||||||
| text |
0..1 | string | Human readable offer text | |||||
| linkId |
0..* | string | Pointer to text | |||||
| securityLabelNumber |
0..* | unsignedInt | Offer restriction numbers | |||||
| asset |
0..* | BackboneElement | Contract Term Asset List | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| scope |
0..1 | CodeableConcept | Range of asset Binding: ContractResourceAssetScopeCodes (example): Codes for scoping an asset. | |||||
| type |
0..* | CodeableConcept | Asset category Binding: ContractResourceAssetTypeCodes (example): Condes for the type of an asset. | |||||
| typeReference |
0..* | Reference(Resource) | Associated entities | |||||
| subtype |
0..* | CodeableConcept | Asset sub-category Binding: ContractResourceAssetSub-TypeCodes (example): Condes for the sub-type of an asset. | |||||
| relationship |
0..1 | Coding | Kinship of the asset Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |||||
| context |
0..* | BackboneElement | Circumstance of the asset | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| reference |
0..1 | Reference(Resource) | Creator,custodian or owner | |||||
| code |
0..* | CodeableConcept | Codeable asset context Binding: ContractResourceAssetContextCodes (example): Codes for the context of the asset. | |||||
| text |
0..1 | string | Context description | |||||
| condition |
0..1 | string | Quality desctiption of asset | |||||
| periodType |
0..* | CodeableConcept | Asset availability types Binding: ContractResourceAssetAvailiabilityCodes (example): Codes for asset availability. | |||||
| period |
0..* | Period | Time period of the asset | |||||
| usePeriod |
0..* | Period | Time period | |||||
| text |
0..1 | string | Asset clause or question text | |||||
| linkId |
0..* | string | Pointer to asset text | |||||
 answer |
0..* | See answer (Contract) | Response to assets | |||||
| securityLabelNumber |
0..* | unsignedInt | Asset restriction numbers | |||||
| valuedItem |
0..* | BackboneElement | Contract Valued Item List | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| entity[x] |
0..1 | Contract Valued Item Type | ||||||
| entityCodeableConcept |
CodeableConcept | |||||||
| entityReference |
Reference(Resource) | |||||||
| identifier |
0..1 | Identifier | Contract Valued Item Number | |||||
| effectiveTime |
0..1 | dateTime | Contract Valued Item Effective Tiem | |||||
| quantity |
0..1 | SimpleQuantity | Count of Contract Valued Items | |||||
| unitPrice |
0..1 | Money | Contract Valued Item fee, charge, or cost | |||||
| factor |
0..1 | decimal | Contract Valued Item Price Scaling Factor | |||||
| points |
0..1 | decimal | Contract Valued Item Difficulty Scaling Factor | |||||
| net |
0..1 | Money | Total Contract Valued Item Value | |||||
| payment |
0..1 | string | Terms of valuation | |||||
| paymentDate |
0..1 | dateTime | When payment is due | |||||
| responsible |
0..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile) | Who will make payment | |||||
| recipient |
0..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile) | Who will receive payment | |||||
| linkId |
0..* | string | Pointer to specific item | |||||
| securityLabelNumber |
0..* | unsignedInt | Security Labels that define affected terms | |||||
| action |
0..* | BackboneElement | Entity being ascribed responsibility | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| doNotPerform |
?! | 0..1 | boolean | True if the term prohibits the action | ||||
| type |
1..1 | CodeableConcept | Type or form of the action Binding: ContractActionCodes (example): Detailed codes for the contract action. | |||||
| subject |
0..* | BackboneElement | Entity of the action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| reference |
1..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | Group | US Core Organization Profile) | Entity of the action | |||||
| role |
0..1 | CodeableConcept | Role type of the agent Binding: ContractActorRoleCodes (example): Detailed codes for the contract actor role. | |||||
| intent |
1..1 | CodeableConcept | Purpose for the Contract Term Action Binding: PurposeOfUse (example): Detailed codes for the contract action reason. | |||||
| linkId |
0..* | string | Pointer to specific item | |||||
| status |
1..1 | CodeableConcept | State of the action Binding: ContractResourceActionStatusCodes (example): Codes for the status of an term action. | |||||
| context |
0..1 | Reference(EpisodeOfCare_eltss | US Core Encounter Profile) | Episode associated with action | |||||
| contextLinkId |
0..* | string | Pointer to specific item | |||||
| occurrence[x] |
0..1 | When action happens | ||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| requester |
0..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | Group | US Core Organization Profile) | Who asked for action | |||||
| requesterLinkId |
0..* | string | Pointer to specific item | |||||
| performerType |
0..* | CodeableConcept | Kind of service performer Binding: ProvenanceParticipantType (example): Codes for the types of action perfomer. | |||||
| performerRole |
0..1 | CodeableConcept | Competency of the performer Binding: ProvenanceParticipantRole (example): Codes for the role of the action performer. | |||||
| performer |
0..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | US Core Organization Profile) | Actor that wil execute (or not) the action | |||||
| performerLinkId |
0..* | string | Pointer to specific item | |||||
| reasonCode |
0..* | CodeableConcept | Why is action (not) needed? Binding: PurposeOfUse (example): Detailed codes for the contract action reason. | |||||
| reasonReference |
0..* | Reference(Condition_eltss | Observation_eltss | Questionnaire_eltss | US Core DocumentReference Profile | DiagnosticReport | QuestionnaireResponse) | Why is action (not) needed? | |||||
| reason |
0..* | string | Why action is to be performed | |||||
| reasonLinkId |
0..* | string | Pointer to specific item | |||||
| note |
0..* | Annotation | Comments about the action | |||||
| securityLabelNumber |
0..* | unsignedInt | Action restriction numbers | |||||
| group |
0..* | See term (Contract) | Nested Contract Term Group | |||||
| supportingInfo |
0..* | Reference(Resource) | Extra Information | |||||
| relevantHistory |
0..* | Reference(Provenance) | Key event in Contract History | |||||
| signer |
S | 0..* | BackboneElement | Person, Guardian / Legal Representative, Support Planner, or Service Provider Signature | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
S | 1..1 | Coding | Contract Signatory Role Binding: ContractSignerTypeCodes (preferred): List of parties who may be signing. | ||||
| party |
S | 1..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile) | Person, Guardian / Legal Representative, Support Planner, or Service Provider Printed Name | ||||
| signature |
S | 1..* | Signature | Contract Documentation Signature | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
SΣ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. | ||||
| when |
SΣ | 1..1 | instant | Person, Guardian / Legal Representative, Support Planner, or Service Provider Signature Date | ||||
| who |
SΣ | 1..1 | Reference(eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile | Practitioner_eltss | Patient_eltss) | Person, Guardian/Legal Representative, Support Planner, or Service Provider Printed Name | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented | ||||
| targetFormat |
0..1 | code | The technical format of the signed resources Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |||||
| sigFormat |
0..1 | code | The technical format of the signature Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |||||
| data |
S | 0..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) | ||||
| friendly |
0..* | BackboneElement | Contract Friendly Language | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| content[x] |
1..1 | Easily comprehended representation of this Contract | ||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Composition | DocumentReference | QuestionnaireResponse) | |||||||
| legal |
0..* | BackboneElement | Contract Legal Language | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| content[x] |
1..1 | Contract Legal Text | ||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Composition | DocumentReference | QuestionnaireResponse) | |||||||
| rule |
0..* | BackboneElement | Computable Contract Language | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| content[x] |
1..1 | Computable Contract Rule(s) | ||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(DocumentReference) | |||||||
| legallyBinding[x] |
0..1 | Binding Contract | ||||||
| legallyBindingAttachment |
Attachment | |||||||
| legallyBindingReference |
Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Contract.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1from the FHIR Standard | ||||
| Contract.legalState | extensible | ContractResourceLegalStateCodeshttp://hl7.org/fhir/ValueSet/contract-legalstatefrom the FHIR Standard | ||||
| Contract.contentDerivative | example | ContractContentDerivationCodeshttp://hl7.org/fhir/ValueSet/contract-content-derivativefrom the FHIR Standard | ||||
| Contract.expirationType | example | ContractResourceExpirationTypeCodeshttp://hl7.org/fhir/ValueSet/contract-expiration-typefrom the FHIR Standard | ||||
| Contract.scope | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-scopefrom the FHIR Standard | ||||
| Contract.type | example | ContractTypeCodeshttp://hl7.org/fhir/ValueSet/contract-typefrom the FHIR Standard | ||||
| Contract.subType | example | ContractSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-subtypefrom the FHIR Standard | ||||
| Contract.contentDefinition.type | example | ContractResourceDefinitionTypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-typefrom the FHIR Standard | ||||
| Contract.contentDefinition.subType | example | ContractResourceDefinitionSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-subtypefrom the FHIR Standard | ||||
| Contract.contentDefinition.publicationStatus | required | ContractResourcePublicationStatusCodeshttp://hl7.org/fhir/ValueSet/contract-publicationstatus|4.0.1from the FHIR Standard | ||||
| Contract.term.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-typefrom the FHIR Standard | ||||
| Contract.term.subType | example | ContractTermSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-subtypefrom the FHIR Standard | ||||
| Contract.term.securityLabel.classification | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-classificationfrom the FHIR Standard | ||||
| Contract.term.securityLabel.category | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-categoryfrom the FHIR Standard | ||||
| Contract.term.securityLabel.control | example | ContractResourceSecurityControlCodeshttp://hl7.org/fhir/ValueSet/contract-security-controlfrom the FHIR Standard | ||||
| Contract.term.offer.party.role | example | ContractResourcePartyRoleCodeshttp://hl7.org/fhir/ValueSet/contract-party-rolefrom the FHIR Standard | ||||
| Contract.term.offer.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-typefrom the FHIR Standard | ||||
| Contract.term.offer.decision | extensible | ActConsentDirectivehttp://terminology.hl7.org/ValueSet/v3-ActConsentDirective | ||||
| Contract.term.offer.decisionMode | example | ContractResourceDecisionModeCodeshttp://hl7.org/fhir/ValueSet/contract-decision-modefrom the FHIR Standard | ||||
| Contract.term.asset.scope | example | ContractResourceAssetScopeCodeshttp://hl7.org/fhir/ValueSet/contract-assetscopefrom the FHIR Standard | ||||
| Contract.term.asset.type | example | ContractResourceAssetTypeCodeshttp://hl7.org/fhir/ValueSet/contract-assettypefrom the FHIR Standard | ||||
| Contract.term.asset.subtype | example | ContractResourceAssetSub-TypeCodeshttp://hl7.org/fhir/ValueSet/contract-assetsubtypefrom the FHIR Standard | ||||
| Contract.term.asset.relationship | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classfrom the FHIR Standard | ||||
| Contract.term.asset.context.code | example | ContractResourceAssetContextCodeshttp://hl7.org/fhir/ValueSet/contract-assetcontextfrom the FHIR Standard | ||||
| Contract.term.asset.periodType | example | ContractResourceAssetAvailiabilityCodeshttp://hl7.org/fhir/ValueSet/asset-availabilityfrom the FHIR Standard | ||||
| Contract.term.action.type | example | ContractActionCodeshttp://hl7.org/fhir/ValueSet/contract-actionfrom the FHIR Standard | ||||
| Contract.term.action.subject.role | example | ContractActorRoleCodeshttp://hl7.org/fhir/ValueSet/contract-actorrolefrom the FHIR Standard | ||||
| Contract.term.action.intent | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Contract.term.action.status | example | ContractResourceActionStatusCodeshttp://hl7.org/fhir/ValueSet/contract-actionstatusfrom the FHIR Standard | ||||
| Contract.term.action.performerType | example | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | ||||
| Contract.term.action.performerRole | example | ProvenanceParticipantRolehttp://hl7.org/fhir/ValueSet/provenance-agent-rolefrom the FHIR Standard | ||||
| Contract.term.action.reasonCode | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Contract.signer.type | preferred | ContractSignerTypeCodeshttp://hl7.org/fhir/ValueSet/contract-signer-typefrom the FHIR Standard | ||||
| Contract.signer.signature.type | preferred | SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-typefrom the FHIR Standard | ||||
| Contract.signer.signature.targetFormat | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| Contract.signer.signature.sigFormat | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Contract | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Contract | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Contract | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Contract
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Differential View
This structure is derived from Contract
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Contract |
0..* | Contract | Legal Agreement | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by type:url | |
| resource-pertainsToGoal |
S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 0..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance. |
| instantiatesCanonical |
0..1 | Reference(Contract_eltss) | Source Contract Definition | |
| domain |
0..* | Reference(Location_eltss) | A sphere of control governed by an authoritative jurisdiction, organization, or person | |
| site |
0..* | Reference(Location_eltss) | Specific Location | |
| author |
0..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | US Core Organization Profile) | Source of Contract | |
| term |
0..* | BackboneElement | Contract Term List | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| offer |
1..1 | BackboneElement | Context of the Contract term | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| party |
0..* | BackboneElement | Offer Recipient | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reference |
1..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | Group | US Core Organization Profile) | Referenced entity | |
| role |
1..1 | CodeableConcept | Participant engagement type Binding: ContractResourcePartyRoleCodes (example): Codes for offer participant roles. | |
| signer |
S | 0..* | BackboneElement | Person, Guardian / Legal Representative, Support Planner, or Service Provider Signature |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
S | 1..1 | Coding | Contract Signatory Role Binding: ContractSignerTypeCodes (preferred): List of parties who may be signing. |
| party |
S | 1..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile) | Person, Guardian / Legal Representative, Support Planner, or Service Provider Printed Name |
| signature |
S | 1..* | Signature | Contract Documentation Signature |
| type |
SΣ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. |
| when |
SΣ | 1..1 | instant | Person, Guardian / Legal Representative, Support Planner, or Service Provider Signature Date |
| who |
SΣ | 1..1 | Reference(eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile | Practitioner_eltss | Patient_eltss) | Person, Guardian/Legal Representative, Support Planner, or Service Provider Printed Name |
| data |
S | 0..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) |
| rule |
0..* | BackboneElement | Computable Contract Language | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| content[x] |
1..1 | Computable Contract Rule(s) | ||
| contentAttachment |
Attachment | |||
| contentReference |
Reference(DocumentReference) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1from the FHIR Standard | |
| Contract.term.offer.party.role | example | ContractResourcePartyRoleCodeshttp://hl7.org/fhir/ValueSet/contract-party-rolefrom the FHIR Standard | |
| Contract.signer.type | preferred | ContractSignerTypeCodeshttp://hl7.org/fhir/ValueSet/contract-signer-typefrom the FHIR Standard | |
| Contract.signer.signature.type | preferred | SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Contract | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Contract | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Contract | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Contract |
0..* | Contract | Legal Agreement | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by type:url | |||||
| resource-pertainsToGoal |
S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Contract number | ||||
| url |
0..1 | uri | Basal definition | |||||
| version |
Σ | 0..1 | string | Business edition | ||||
| status |
?!Σ | 0..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
| legalState |
0..1 | CodeableConcept | Negotiation status Binding: ContractResourceLegalStateCodes (extensible): Detailed codes for the legal state of a contract. | |||||
| instantiatesCanonical |
0..1 | Reference(Contract_eltss) | Source Contract Definition | |||||
| instantiatesUri |
0..1 | uri | External Contract Definition | |||||
| contentDerivative |
0..1 | CodeableConcept | Content derived from the basal information Binding: ContractContentDerivationCodes (example): This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source. | |||||
| issued |
Σ | 0..1 | dateTime | When this Contract was issued | ||||
| applies |
Σ | 0..1 | Period | Effective time | ||||
| expirationType |
0..1 | CodeableConcept | Contract cessation cause Binding: ContractResourceExpirationTypeCodes (example): Codes for the Cessation of Contracts. | |||||
| subject |
Σ | 0..* | Reference(Resource) | Contract Target Entity | ||||
| authority |
0..* | Reference(Organization) | Authority under which this Contract has standing | |||||
| domain |
0..* | Reference(Location_eltss) | A sphere of control governed by an authoritative jurisdiction, organization, or person | |||||
| site |
0..* | Reference(Location_eltss) | Specific Location | |||||
| name |
Σ | 0..1 | string | Computer friendly designation | ||||
| title |
Σ | 0..1 | string | Human Friendly name | ||||
| subtitle |
0..1 | string | Subordinate Friendly name | |||||
| alias |
0..* | string | Acronym or short name | |||||
| author |
0..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | US Core Organization Profile) | Source of Contract | |||||
| scope |
0..1 | CodeableConcept | Range of Legal Concerns Binding: ContractResourceScopeCodes (example): Codes for the range of legal concerns. | |||||
| topic[x] |
0..1 | Focus of contract interest | ||||||
| topicCodeableConcept |
CodeableConcept | |||||||
| topicReference |
Reference(Resource) | |||||||
| type |
Σ | 0..1 | CodeableConcept | Legal instrument category Binding: ContractTypeCodes (example): List of overall contract codes. | ||||
| subType |
Σ | 0..* | CodeableConcept | Subtype within the context of type Binding: ContractSubtypeCodes (example): Detailed codes within the above. | ||||
| contentDefinition |
0..1 | BackboneElement | Contract precursor content | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Content structure and use Binding: ContractResourceDefinitionTypeCodes (example): Detailed codes for the definition of contracts. | |||||
| subType |
0..1 | CodeableConcept | Detailed Content Type Definition Binding: ContractResourceDefinitionSubtypeCodes (example): Detailed codes for the additional definition of contracts. | |||||
| publisher |
0..1 | Reference(Practitioner_eltss | eLTSS PractitionerRole Profile | US Core Organization Profile) | Publisher Entity | |||||
| publicationDate |
0..1 | dateTime | When published | |||||
| publicationStatus |
1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourcePublicationStatusCodes (required): Status of the publication of contract content. | |||||
| copyright |
0..1 | markdown | Publication Ownership | |||||
| term |
0..* | BackboneElement | Contract Term List | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
Σ | 0..1 | Identifier | Contract Term Number | ||||
| issued |
Σ | 0..1 | dateTime | Contract Term Issue Date Time | ||||
| applies |
Σ | 0..1 | Period | Contract Term Effective Time | ||||
| topic[x] |
0..1 | Term Concern | ||||||
| topicCodeableConcept |
CodeableConcept | |||||||
| topicReference |
Reference(Resource) | |||||||
| type |
0..1 | CodeableConcept | Contract Term Type or Form Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions. | |||||
| subType |
0..1 | CodeableConcept | Contract Term Type specific classification Binding: ContractTermSubtypeCodes (example): Detailed codes for the subtypes of contract provisions. | |||||
| text |
Σ | 0..1 | string | Term Statement | ||||
| securityLabel |
0..* | BackboneElement | Protection for the Term | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| number |
0..* | unsignedInt | Link to Security Labels | |||||
| classification |
1..1 | Coding | Confidentiality Protection Binding: ContractResourceScopeCodes (example): Codes for confidentiality protection. | |||||
| category |
0..* | Coding | Applicable Policy Binding: ContractResourceScopeCodes (example): Codes for policy category. | |||||
| control |
0..* | Coding | Handling Instructions Binding: ContractResourceSecurityControlCodes (example): Codes for handling instructions. | |||||
| offer |
1..1 | BackboneElement | Context of the Contract term | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | Offer business ID | |||||
| party |
0..* | BackboneElement | Offer Recipient | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| reference |
1..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | Group | US Core Organization Profile) | Referenced entity | |||||
| role |
1..1 | CodeableConcept | Participant engagement type Binding: ContractResourcePartyRoleCodes (example): Codes for offer participant roles. | |||||
| topic |
Σ | 0..1 | Reference(Resource) | Negotiable offer asset | ||||
| type |
0..1 | CodeableConcept | Contract Offer Type or Form Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions. | |||||
| decision |
0..1 | CodeableConcept | Accepting party choice Binding: ActConsentDirective (extensible): The type of decision made by a grantor with respect to an offer made by a grantee. | |||||
| decisionMode |
0..* | CodeableConcept | How decision is conveyed Binding: ContractResourceDecisionModeCodes (example): Codes for conveying a decision. | |||||
| answer |
0..* | BackboneElement | Response to offer text | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] |
1..1 | The actual answer response | ||||||
| valueBoolean |
boolean | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueUri |
uri | |||||||
| valueAttachment |
Attachment | |||||||
| valueCoding |
Coding | |||||||
| valueQuantity |
Quantity | |||||||
| valueReference |
Reference(Resource) | |||||||
| text |
0..1 | string | Human readable offer text | |||||
| linkId |
0..* | string | Pointer to text | |||||
| securityLabelNumber |
0..* | unsignedInt | Offer restriction numbers | |||||
| asset |
0..* | BackboneElement | Contract Term Asset List | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| scope |
0..1 | CodeableConcept | Range of asset Binding: ContractResourceAssetScopeCodes (example): Codes for scoping an asset. | |||||
| type |
0..* | CodeableConcept | Asset category Binding: ContractResourceAssetTypeCodes (example): Condes for the type of an asset. | |||||
| typeReference |
0..* | Reference(Resource) | Associated entities | |||||
| subtype |
0..* | CodeableConcept | Asset sub-category Binding: ContractResourceAssetSub-TypeCodes (example): Condes for the sub-type of an asset. | |||||
| relationship |
0..1 | Coding | Kinship of the asset Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |||||
| context |
0..* | BackboneElement | Circumstance of the asset | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| reference |
0..1 | Reference(Resource) | Creator,custodian or owner | |||||
| code |
0..* | CodeableConcept | Codeable asset context Binding: ContractResourceAssetContextCodes (example): Codes for the context of the asset. | |||||
| text |
0..1 | string | Context description | |||||
| condition |
0..1 | string | Quality desctiption of asset | |||||
| periodType |
0..* | CodeableConcept | Asset availability types Binding: ContractResourceAssetAvailiabilityCodes (example): Codes for asset availability. | |||||
| period |
0..* | Period | Time period of the asset | |||||
| usePeriod |
0..* | Period | Time period | |||||
| text |
0..1 | string | Asset clause or question text | |||||
| linkId |
0..* | string | Pointer to asset text | |||||
| answer |
0..* | See answer (Contract) | Response to assets | |||||
| securityLabelNumber |
0..* | unsignedInt | Asset restriction numbers | |||||
| valuedItem |
0..* | BackboneElement | Contract Valued Item List | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| entity[x] |
0..1 | Contract Valued Item Type | ||||||
| entityCodeableConcept |
CodeableConcept | |||||||
| entityReference |
Reference(Resource) | |||||||
| identifier |
0..1 | Identifier | Contract Valued Item Number | |||||
| effectiveTime |
0..1 | dateTime | Contract Valued Item Effective Tiem | |||||
| quantity |
0..1 | SimpleQuantity | Count of Contract Valued Items | |||||
| unitPrice |
0..1 | Money | Contract Valued Item fee, charge, or cost | |||||
| factor |
0..1 | decimal | Contract Valued Item Price Scaling Factor | |||||
| points |
0..1 | decimal | Contract Valued Item Difficulty Scaling Factor | |||||
| net |
0..1 | Money | Total Contract Valued Item Value | |||||
| payment |
0..1 | string | Terms of valuation | |||||
| paymentDate |
0..1 | dateTime | When payment is due | |||||
| responsible |
0..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile) | Who will make payment | |||||
| recipient |
0..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile) | Who will receive payment | |||||
| linkId |
0..* | string | Pointer to specific item | |||||
| securityLabelNumber |
0..* | unsignedInt | Security Labels that define affected terms | |||||
| action |
0..* | BackboneElement | Entity being ascribed responsibility | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| doNotPerform |
?! | 0..1 | boolean | True if the term prohibits the action | ||||
| type |
1..1 | CodeableConcept | Type or form of the action Binding: ContractActionCodes (example): Detailed codes for the contract action. | |||||
| subject |
0..* | BackboneElement | Entity of the action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| reference |
1..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | Group | US Core Organization Profile) | Entity of the action | |||||
| role |
0..1 | CodeableConcept | Role type of the agent Binding: ContractActorRoleCodes (example): Detailed codes for the contract actor role. | |||||
| intent |
1..1 | CodeableConcept | Purpose for the Contract Term Action Binding: PurposeOfUse (example): Detailed codes for the contract action reason. | |||||
| linkId |
0..* | string | Pointer to specific item | |||||
| status |
1..1 | CodeableConcept | State of the action Binding: ContractResourceActionStatusCodes (example): Codes for the status of an term action. | |||||
| context |
0..1 | Reference(EpisodeOfCare_eltss | US Core Encounter Profile) | Episode associated with action | |||||
| contextLinkId |
0..* | string | Pointer to specific item | |||||
| occurrence[x] |
0..1 | When action happens | ||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| requester |
0..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | Group | US Core Organization Profile) | Who asked for action | |||||
| requesterLinkId |
0..* | string | Pointer to specific item | |||||
| performerType |
0..* | CodeableConcept | Kind of service performer Binding: ProvenanceParticipantType (example): Codes for the types of action perfomer. | |||||
| performerRole |
0..1 | CodeableConcept | Competency of the performer Binding: ProvenanceParticipantRole (example): Codes for the role of the action performer. | |||||
| performer |
0..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | US Core Organization Profile) | Actor that wil execute (or not) the action | |||||
| performerLinkId |
0..* | string | Pointer to specific item | |||||
| reasonCode |
0..* | CodeableConcept | Why is action (not) needed? Binding: PurposeOfUse (example): Detailed codes for the contract action reason. | |||||
| reasonReference |
0..* | Reference(Condition_eltss | Observation_eltss | Questionnaire_eltss | US Core DocumentReference Profile | DiagnosticReport | QuestionnaireResponse) | Why is action (not) needed? | |||||
| reason |
0..* | string | Why action is to be performed | |||||
| reasonLinkId |
0..* | string | Pointer to specific item | |||||
| note |
0..* | Annotation | Comments about the action | |||||
| securityLabelNumber |
0..* | unsignedInt | Action restriction numbers | |||||
| group |
0..* | See term (Contract) | Nested Contract Term Group | |||||
| supportingInfo |
0..* | Reference(Resource) | Extra Information | |||||
| relevantHistory |
0..* | Reference(Provenance) | Key event in Contract History | |||||
| signer |
S | 0..* | BackboneElement | Person, Guardian / Legal Representative, Support Planner, or Service Provider Signature | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
S | 1..1 | Coding | Contract Signatory Role Binding: ContractSignerTypeCodes (preferred): List of parties who may be signing. | ||||
| party |
S | 1..1 | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile) | Person, Guardian / Legal Representative, Support Planner, or Service Provider Printed Name | ||||
| signature |
S | 1..* | Signature | Contract Documentation Signature | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
SΣ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. | ||||
| when |
SΣ | 1..1 | instant | Person, Guardian / Legal Representative, Support Planner, or Service Provider Signature Date | ||||
| who |
SΣ | 1..1 | Reference(eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile | Practitioner_eltss | Patient_eltss) | Person, Guardian/Legal Representative, Support Planner, or Service Provider Printed Name | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented | ||||
| targetFormat |
0..1 | code | The technical format of the signed resources Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |||||
| sigFormat |
0..1 | code | The technical format of the signature Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |||||
| data |
S | 0..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) | ||||
| friendly |
0..* | BackboneElement | Contract Friendly Language | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| content[x] |
1..1 | Easily comprehended representation of this Contract | ||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Composition | DocumentReference | QuestionnaireResponse) | |||||||
| legal |
0..* | BackboneElement | Contract Legal Language | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| content[x] |
1..1 | Contract Legal Text | ||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Composition | DocumentReference | QuestionnaireResponse) | |||||||
| rule |
0..* | BackboneElement | Computable Contract Language | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| content[x] |
1..1 | Computable Contract Rule(s) | ||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(DocumentReference) | |||||||
| legallyBinding[x] |
0..1 | Binding Contract | ||||||
| legallyBindingAttachment |
Attachment | |||||||
| legallyBindingReference |
Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Contract.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1from the FHIR Standard | ||||
| Contract.legalState | extensible | ContractResourceLegalStateCodeshttp://hl7.org/fhir/ValueSet/contract-legalstatefrom the FHIR Standard | ||||
| Contract.contentDerivative | example | ContractContentDerivationCodeshttp://hl7.org/fhir/ValueSet/contract-content-derivativefrom the FHIR Standard | ||||
| Contract.expirationType | example | ContractResourceExpirationTypeCodeshttp://hl7.org/fhir/ValueSet/contract-expiration-typefrom the FHIR Standard | ||||
| Contract.scope | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-scopefrom the FHIR Standard | ||||
| Contract.type | example | ContractTypeCodeshttp://hl7.org/fhir/ValueSet/contract-typefrom the FHIR Standard | ||||
| Contract.subType | example | ContractSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-subtypefrom the FHIR Standard | ||||
| Contract.contentDefinition.type | example | ContractResourceDefinitionTypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-typefrom the FHIR Standard | ||||
| Contract.contentDefinition.subType | example | ContractResourceDefinitionSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-subtypefrom the FHIR Standard | ||||
| Contract.contentDefinition.publicationStatus | required | ContractResourcePublicationStatusCodeshttp://hl7.org/fhir/ValueSet/contract-publicationstatus|4.0.1from the FHIR Standard | ||||
| Contract.term.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-typefrom the FHIR Standard | ||||
| Contract.term.subType | example | ContractTermSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-subtypefrom the FHIR Standard | ||||
| Contract.term.securityLabel.classification | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-classificationfrom the FHIR Standard | ||||
| Contract.term.securityLabel.category | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-categoryfrom the FHIR Standard | ||||
| Contract.term.securityLabel.control | example | ContractResourceSecurityControlCodeshttp://hl7.org/fhir/ValueSet/contract-security-controlfrom the FHIR Standard | ||||
| Contract.term.offer.party.role | example | ContractResourcePartyRoleCodeshttp://hl7.org/fhir/ValueSet/contract-party-rolefrom the FHIR Standard | ||||
| Contract.term.offer.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-typefrom the FHIR Standard | ||||
| Contract.term.offer.decision | extensible | ActConsentDirectivehttp://terminology.hl7.org/ValueSet/v3-ActConsentDirective | ||||
| Contract.term.offer.decisionMode | example | ContractResourceDecisionModeCodeshttp://hl7.org/fhir/ValueSet/contract-decision-modefrom the FHIR Standard | ||||
| Contract.term.asset.scope | example | ContractResourceAssetScopeCodeshttp://hl7.org/fhir/ValueSet/contract-assetscopefrom the FHIR Standard | ||||
| Contract.term.asset.type | example | ContractResourceAssetTypeCodeshttp://hl7.org/fhir/ValueSet/contract-assettypefrom the FHIR Standard | ||||
| Contract.term.asset.subtype | example | ContractResourceAssetSub-TypeCodeshttp://hl7.org/fhir/ValueSet/contract-assetsubtypefrom the FHIR Standard | ||||
| Contract.term.asset.relationship | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classfrom the FHIR Standard | ||||
| Contract.term.asset.context.code | example | ContractResourceAssetContextCodeshttp://hl7.org/fhir/ValueSet/contract-assetcontextfrom the FHIR Standard | ||||
| Contract.term.asset.periodType | example | ContractResourceAssetAvailiabilityCodeshttp://hl7.org/fhir/ValueSet/asset-availabilityfrom the FHIR Standard | ||||
| Contract.term.action.type | example | ContractActionCodeshttp://hl7.org/fhir/ValueSet/contract-actionfrom the FHIR Standard | ||||
| Contract.term.action.subject.role | example | ContractActorRoleCodeshttp://hl7.org/fhir/ValueSet/contract-actorrolefrom the FHIR Standard | ||||
| Contract.term.action.intent | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Contract.term.action.status | example | ContractResourceActionStatusCodeshttp://hl7.org/fhir/ValueSet/contract-actionstatusfrom the FHIR Standard | ||||
| Contract.term.action.performerType | example | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | ||||
| Contract.term.action.performerRole | example | ProvenanceParticipantRolehttp://hl7.org/fhir/ValueSet/provenance-agent-rolefrom the FHIR Standard | ||||
| Contract.term.action.reasonCode | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Contract.signer.type | preferred | ContractSignerTypeCodeshttp://hl7.org/fhir/ValueSet/contract-signer-typefrom the FHIR Standard | ||||
| Contract.signer.signature.type | preferred | SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-typefrom the FHIR Standard | ||||
| Contract.signer.signature.targetFormat | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| Contract.signer.signature.sigFormat | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Contract | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Contract | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Contract | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Contract
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Human and Social Services. Package hl7.fhir.us.eltss#2.0.0 based on FHIR 4.0.1. Generated 2024-05-23
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change