LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
Official URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ffv-initative-resource | Version: 8.0.0 | |||
Active as of 2022-11-10 | Computable Name: FFVInitiative |
LinuxForHealth Common Data Model definition of what fields we currently define for an FFV initiative record
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 | |
meta | 0..1 | ProcessMeta | Metadata about a resource | |
profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
contained | 0..0 | |||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
attributionCode | 1..1 | CodeableConcept | FFV initiative attribution method code URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/attribution-code Binding: Attribution Codes (required) | |
ffvSchedule | 1..1 | CodeableConcept | Schedule code for the FFV initiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ffv-schedule Binding: FFV Schedule Value Set (required) | |
qualityMeasures | 0..* | Reference(Quality Measure List) | Quality measures related to the FFV intitiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/quality-measures | |
Slices for identifier | 2..* | Identifier | Contract number Slice: Ordered, Open by pattern:type | |
identifier:key | 1..1 | Identifier | Contract number | |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADKEY | |
identifier:customerId | 1..1 | Identifier | Contract number | |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CUSTKEY | |
title | 1..1 | string | Human Friendly name | |
Slices for supportingInfo | 2..* | Reference(Resource) | Extra Information Slice: Ordered, Open by pattern:type | |
supportingInfo:participatingProviders | 1..1 | Reference(Practitioner List) | Extra Information | |
supportingInfo:excludedPatients | 1..1 | Reference(Patient List) | Extra Information | |
supportingInfo:includedPatients | 0..1 | Reference(Patient List) | Extra Information | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Contract | 0..* | Contract | Legal Agreement | |
meta | 0..1 | ProcessMeta | Metadata about a resource | |
ingestionBatchId | 0..1 | string | The ID generated by an ingestion service. This represents a producer-submitted message collection URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ingestion-batch-id | |
tenantId | 0..1 | string | The ID for either the client or tenant that holds the contract with the data receiver, as recorded by the data receiver URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/tenant-id | |
processClientId | 0..1 | string | The ID of the client as recorded in the data producer or data integrator source system(s) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-client-id | |
processOrganization | 0..1 | string | The organizing entity that owns the process that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-organization | |
processName | 0..1 | string | The name of the process or service that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-name | |
processVersion | 0..1 | string | The version of either the process or the service that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-version | |
processType | 0..1 | string | The classification type of the process that has produced the data held in either the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-type | |
processRecordId | 0..* | Identifier | The record ID that the data producer or data integrator uses internally to identify this data URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-record-id | |
processTimestamp | 0..1 | dateTime | The timestamp when the data was generated within the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp | |
sourceRecordId | 0..* | string | The ID for a record that the data producer or data integrator extracted knowledge from to produce the data within the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-id | |
sourceFileId | 0..* | string | The ID for a file from which the data producer or data integrator extracted knowledge, to produce the data within this FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-file-id | |
sourceRecordType | 0..1 | CodeableConcept | Either the data model type or schema type that generates this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-type | |
sourceDataModelVersion | 0..1 | string | Version of the source system's data model, used by either the data producer or the data integrator URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-data-model-version | |
sourceEventTrigger | 0..1 | CodeableConcept | The event that is the catalyst for creating or updating this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger | |
extension | 0..0 | |||
url | 1..1 | uri | "http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: hl7VS-eventTypeCode (example) | |
sourceEventTimestamp | 0..1 | dateTime | Date and time of the source event that triggers either the creation or updating of this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-timestamp | |
insight | 0..* | (Complex) | References element level insight results pertaining to the data in this resource instance. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/insight | |
profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
tag:SourceClassificationTag | Σ | 0..1 | Coding | Identifies the origin of this FHIR resource, from either a source system of record or derived from a process Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
attributionCode | 1..1 | CodeableConcept | FFV initiative attribution method code URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/attribution-code Binding: Attribution Codes (required) | |
ffvSchedule | 1..1 | CodeableConcept | Schedule code for the FFV initiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ffv-schedule Binding: FFV Schedule Value Set (required) | |
qualityMeasures | 0..* | Reference(Quality Measure List) | Quality measures related to the FFV intitiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/quality-measures | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 2..* | Identifier | Contract number Slice: Ordered, Open by pattern:type |
identifier:key | Σ | 1..1 | Identifier | Contract number |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADKEY | |
identifier:customerId | Σ | 1..1 | Identifier | Contract number |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CUSTKEY | |
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. |
title | Σ | 1..1 | string | Human Friendly name |
Slices for supportingInfo | 2..* | Reference(Resource) | Extra Information Slice: Ordered, Open by pattern:type | |
supportingInfo:participatingProviders | 1..1 | Reference(Practitioner List) | Extra Information | |
supportingInfo:excludedPatients | 1..1 | Reference(Patient List) | Extra Information | |
supportingInfo:includedPatients | 0..1 | Reference(Patient List) | Extra Information | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Contract.meta.extension:sourceEventTrigger.value[x]:valueCodeableConcept | example | Hl7VSEventTypeCode |
Contract.meta.tag | example | CommonTags |
Contract.meta.tag:SourceClassificationTag | example | CommonTags |
Contract.identifier:key.use | required | IdentifierUse |
Contract.identifier:key.type | extensible | Pattern: ADKEY |
Contract.identifier:customerId.use | required | IdentifierUse |
Contract.identifier:customerId.type | extensible | Pattern: CUSTKEY |
Contract.status | required | ContractResourceStatusCodes |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Contract | 0..* | Contract | Legal Agreement | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | 0..1 | ProcessMeta | Metadata about a resource | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
ingestionBatchId | 0..1 | string | The ID generated by an ingestion service. This represents a producer-submitted message collection URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ingestion-batch-id | |||||
tenantId | 0..1 | string | The ID for either the client or tenant that holds the contract with the data receiver, as recorded by the data receiver URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/tenant-id | |||||
processClientId | 0..1 | string | The ID of the client as recorded in the data producer or data integrator source system(s) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-client-id | |||||
processOrganization | 0..1 | string | The organizing entity that owns the process that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-organization | |||||
processName | 0..1 | string | The name of the process or service that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-name | |||||
processVersion | 0..1 | string | The version of either the process or the service that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-version | |||||
processType | 0..1 | string | The classification type of the process that has produced the data held in either the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-type | |||||
processRecordId | 0..* | Identifier | The record ID that the data producer or data integrator uses internally to identify this data URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-record-id | |||||
processTimestamp | 0..1 | dateTime | The timestamp when the data was generated within the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp | |||||
sourceRecordId | 0..* | string | The ID for a record that the data producer or data integrator extracted knowledge from to produce the data within the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-id | |||||
sourceFileId | 0..* | string | The ID for a file from which the data producer or data integrator extracted knowledge, to produce the data within this FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-file-id | |||||
sourceRecordType | 0..1 | CodeableConcept | Either the data model type or schema type that generates this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-type | |||||
sourceDataModelVersion | 0..1 | string | Version of the source system's data model, used by either the data producer or the data integrator URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-data-model-version | |||||
sourceEventTrigger | 0..1 | CodeableConcept | The event that is the catalyst for creating or updating this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: hl7VS-eventTypeCode (example) | |||||
sourceEventTimestamp | 0..1 | dateTime | Date and time of the source event that triggers either the creation or updating of this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-timestamp | |||||
insight | 0..* | (Complex) | References element level insight results pertaining to the data in this resource instance. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/insight | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:SourceClassificationTag | Σ | 0..1 | Coding | Identifies the origin of this FHIR resource, from either a source system of record or derived from a process Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: Source Classification Value Set (required) | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
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 | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
attributionCode | 1..1 | CodeableConcept | FFV initiative attribution method code URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/attribution-code Binding: Attribution Codes (required) | |||||
ffvSchedule | 1..1 | CodeableConcept | Schedule code for the FFV initiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ffv-schedule Binding: FFV Schedule Value Set (required) | |||||
qualityMeasures | 0..* | Reference(Quality Measure List) | Quality measures related to the FFV intitiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/quality-measures | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 2..* | Identifier | Contract number Slice: Ordered, Open by pattern:type | ||||
identifier:key | Σ | 1..1 | Identifier | Contract number | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADKEY | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:customerId | Σ | 1..1 | Identifier | Contract number | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CUSTKEY | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
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) | 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) | A sphere of control governed by an authoritative jurisdiction, organization, or person | |||||
site | 0..* | Reference(Location) | Specific Location | |||||
name | Σ | 0..1 | string | Computer friendly designation | ||||
title | Σ | 1..1 | string | Human Friendly name | ||||
subtitle | 0..1 | string | Subordinate Friendly name | |||||
alias | 0..* | string | Acronym or short name | |||||
author | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Organization) | 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 | PractitionerRole | Organization) | 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 | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | 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(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who will make payment | |||||
recipient | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 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 | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | 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(Encounter | EpisodeOfCare) | 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 | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | 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(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) | 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 | Observation | DiagnosticReport | DocumentReference | Questionnaire | 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 | |||||
Slices for supportingInfo | 2..* | Reference(Resource) | Extra Information Slice: Ordered, Open by pattern:type | |||||
supportingInfo:participatingProviders | 1..1 | Reference(Practitioner List) | Extra Information | |||||
supportingInfo:excludedPatients | 1..1 | Reference(Patient List) | Extra Information | |||||
supportingInfo:includedPatients | 0..1 | Reference(Patient List) | Extra Information | |||||
relevantHistory | 0..* | Reference(Provenance) | Key event in Contract History | |||||
signer | 0..* | BackboneElement | Contract Signatory | |||||
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 | Coding | Contract Signatory Role Binding: ContractSignerTypeCodes (preferred): List of parties who may be signing. | |||||
party | 1..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Contract Signatory Party | |||||
signature | 1..* | Signature | Contract Documentation Signature | |||||
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 Rules | ||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(DocumentReference) | |||||||
legallyBinding[x] | 0..1 | Binding Contract | ||||||
legallyBindingAttachment | Attachment | |||||||
legallyBindingReference | Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) | |||||||
Documentation for this format |
This structure is derived from Contract
Summary
Mandatory: 9 elements (1 nested mandatory element)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Contract
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Contract | 0..* | Contract | Legal Agreement | |
meta | 0..1 | ProcessMeta | Metadata about a resource | |
profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
contained | 0..0 | |||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
attributionCode | 1..1 | CodeableConcept | FFV initiative attribution method code URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/attribution-code Binding: Attribution Codes (required) | |
ffvSchedule | 1..1 | CodeableConcept | Schedule code for the FFV initiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ffv-schedule Binding: FFV Schedule Value Set (required) | |
qualityMeasures | 0..* | Reference(Quality Measure List) | Quality measures related to the FFV intitiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/quality-measures | |
Slices for identifier | 2..* | Identifier | Contract number Slice: Ordered, Open by pattern:type | |
identifier:key | 1..1 | Identifier | Contract number | |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADKEY | |
identifier:customerId | 1..1 | Identifier | Contract number | |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CUSTKEY | |
title | 1..1 | string | Human Friendly name | |
Slices for supportingInfo | 2..* | Reference(Resource) | Extra Information Slice: Ordered, Open by pattern:type | |
supportingInfo:participatingProviders | 1..1 | Reference(Practitioner List) | Extra Information | |
supportingInfo:excludedPatients | 1..1 | Reference(Patient List) | Extra Information | |
supportingInfo:includedPatients | 0..1 | Reference(Patient List) | Extra Information | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Contract | 0..* | Contract | Legal Agreement | |
meta | 0..1 | ProcessMeta | Metadata about a resource | |
ingestionBatchId | 0..1 | string | The ID generated by an ingestion service. This represents a producer-submitted message collection URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ingestion-batch-id | |
tenantId | 0..1 | string | The ID for either the client or tenant that holds the contract with the data receiver, as recorded by the data receiver URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/tenant-id | |
processClientId | 0..1 | string | The ID of the client as recorded in the data producer or data integrator source system(s) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-client-id | |
processOrganization | 0..1 | string | The organizing entity that owns the process that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-organization | |
processName | 0..1 | string | The name of the process or service that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-name | |
processVersion | 0..1 | string | The version of either the process or the service that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-version | |
processType | 0..1 | string | The classification type of the process that has produced the data held in either the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-type | |
processRecordId | 0..* | Identifier | The record ID that the data producer or data integrator uses internally to identify this data URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-record-id | |
processTimestamp | 0..1 | dateTime | The timestamp when the data was generated within the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp | |
sourceRecordId | 0..* | string | The ID for a record that the data producer or data integrator extracted knowledge from to produce the data within the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-id | |
sourceFileId | 0..* | string | The ID for a file from which the data producer or data integrator extracted knowledge, to produce the data within this FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-file-id | |
sourceRecordType | 0..1 | CodeableConcept | Either the data model type or schema type that generates this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-type | |
sourceDataModelVersion | 0..1 | string | Version of the source system's data model, used by either the data producer or the data integrator URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-data-model-version | |
sourceEventTrigger | 0..1 | CodeableConcept | The event that is the catalyst for creating or updating this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger | |
extension | 0..0 | |||
url | 1..1 | uri | "http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: hl7VS-eventTypeCode (example) | |
sourceEventTimestamp | 0..1 | dateTime | Date and time of the source event that triggers either the creation or updating of this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-timestamp | |
insight | 0..* | (Complex) | References element level insight results pertaining to the data in this resource instance. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/insight | |
profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
tag:SourceClassificationTag | Σ | 0..1 | Coding | Identifies the origin of this FHIR resource, from either a source system of record or derived from a process Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
attributionCode | 1..1 | CodeableConcept | FFV initiative attribution method code URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/attribution-code Binding: Attribution Codes (required) | |
ffvSchedule | 1..1 | CodeableConcept | Schedule code for the FFV initiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ffv-schedule Binding: FFV Schedule Value Set (required) | |
qualityMeasures | 0..* | Reference(Quality Measure List) | Quality measures related to the FFV intitiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/quality-measures | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 2..* | Identifier | Contract number Slice: Ordered, Open by pattern:type |
identifier:key | Σ | 1..1 | Identifier | Contract number |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADKEY | |
identifier:customerId | Σ | 1..1 | Identifier | Contract number |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CUSTKEY | |
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. |
title | Σ | 1..1 | string | Human Friendly name |
Slices for supportingInfo | 2..* | Reference(Resource) | Extra Information Slice: Ordered, Open by pattern:type | |
supportingInfo:participatingProviders | 1..1 | Reference(Practitioner List) | Extra Information | |
supportingInfo:excludedPatients | 1..1 | Reference(Patient List) | Extra Information | |
supportingInfo:includedPatients | 0..1 | Reference(Patient List) | Extra Information | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Contract.meta.extension:sourceEventTrigger.value[x]:valueCodeableConcept | example | Hl7VSEventTypeCode |
Contract.meta.tag | example | CommonTags |
Contract.meta.tag:SourceClassificationTag | example | CommonTags |
Contract.identifier:key.use | required | IdentifierUse |
Contract.identifier:key.type | extensible | Pattern: ADKEY |
Contract.identifier:customerId.use | required | IdentifierUse |
Contract.identifier:customerId.type | extensible | Pattern: CUSTKEY |
Contract.status | required | ContractResourceStatusCodes |
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 | ProcessMeta | Metadata about a resource | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
ingestionBatchId | 0..1 | string | The ID generated by an ingestion service. This represents a producer-submitted message collection URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ingestion-batch-id | |||||
tenantId | 0..1 | string | The ID for either the client or tenant that holds the contract with the data receiver, as recorded by the data receiver URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/tenant-id | |||||
processClientId | 0..1 | string | The ID of the client as recorded in the data producer or data integrator source system(s) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-client-id | |||||
processOrganization | 0..1 | string | The organizing entity that owns the process that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-organization | |||||
processName | 0..1 | string | The name of the process or service that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-name | |||||
processVersion | 0..1 | string | The version of either the process or the service that has produced the data held in the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-version | |||||
processType | 0..1 | string | The classification type of the process that has produced the data held in either the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-type | |||||
processRecordId | 0..* | Identifier | The record ID that the data producer or data integrator uses internally to identify this data URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-record-id | |||||
processTimestamp | 0..1 | dateTime | The timestamp when the data was generated within the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp | |||||
sourceRecordId | 0..* | string | The ID for a record that the data producer or data integrator extracted knowledge from to produce the data within the FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-id | |||||
sourceFileId | 0..* | string | The ID for a file from which the data producer or data integrator extracted knowledge, to produce the data within this FHIR resource or element URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-file-id | |||||
sourceRecordType | 0..1 | CodeableConcept | Either the data model type or schema type that generates this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-type | |||||
sourceDataModelVersion | 0..1 | string | Version of the source system's data model, used by either the data producer or the data integrator URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-data-model-version | |||||
sourceEventTrigger | 0..1 | CodeableConcept | The event that is the catalyst for creating or updating this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: hl7VS-eventTypeCode (example) | |||||
sourceEventTimestamp | 0..1 | dateTime | Date and time of the source event that triggers either the creation or updating of this FHIR resource URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-timestamp | |||||
insight | 0..* | (Complex) | References element level insight results pertaining to the data in this resource instance. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/insight | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:SourceClassificationTag | Σ | 0..1 | Coding | Identifies the origin of this FHIR resource, from either a source system of record or derived from a process Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: Source Classification Value Set (required) | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
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 | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
attributionCode | 1..1 | CodeableConcept | FFV initiative attribution method code URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/attribution-code Binding: Attribution Codes (required) | |||||
ffvSchedule | 1..1 | CodeableConcept | Schedule code for the FFV initiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ffv-schedule Binding: FFV Schedule Value Set (required) | |||||
qualityMeasures | 0..* | Reference(Quality Measure List) | Quality measures related to the FFV intitiative URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/quality-measures | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 2..* | Identifier | Contract number Slice: Ordered, Open by pattern:type | ||||
identifier:key | Σ | 1..1 | Identifier | Contract number | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADKEY | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:customerId | Σ | 1..1 | Identifier | Contract number | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CUSTKEY | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
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) | 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) | A sphere of control governed by an authoritative jurisdiction, organization, or person | |||||
site | 0..* | Reference(Location) | Specific Location | |||||
name | Σ | 0..1 | string | Computer friendly designation | ||||
title | Σ | 1..1 | string | Human Friendly name | ||||
subtitle | 0..1 | string | Subordinate Friendly name | |||||
alias | 0..* | string | Acronym or short name | |||||
author | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Organization) | 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 | PractitionerRole | Organization) | 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 | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | 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(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who will make payment | |||||
recipient | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 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 | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | 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(Encounter | EpisodeOfCare) | 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 | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | 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(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) | 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 | Observation | DiagnosticReport | DocumentReference | Questionnaire | 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 | |||||
Slices for supportingInfo | 2..* | Reference(Resource) | Extra Information Slice: Ordered, Open by pattern:type | |||||
supportingInfo:participatingProviders | 1..1 | Reference(Practitioner List) | Extra Information | |||||
supportingInfo:excludedPatients | 1..1 | Reference(Patient List) | Extra Information | |||||
supportingInfo:includedPatients | 0..1 | Reference(Patient List) | Extra Information | |||||
relevantHistory | 0..* | Reference(Provenance) | Key event in Contract History | |||||
signer | 0..* | BackboneElement | Contract Signatory | |||||
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 | Coding | Contract Signatory Role Binding: ContractSignerTypeCodes (preferred): List of parties who may be signing. | |||||
party | 1..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Contract Signatory Party | |||||
signature | 1..* | Signature | Contract Documentation Signature | |||||
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 Rules | ||||||
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 / Code | ||||
Contract.meta.extension:sourceEventTrigger.value[x]:valueCodeableConcept | example | Hl7VSEventTypeCode | ||||
Contract.meta.security | extensible | All Security Labels | ||||
Contract.meta.tag | example | CommonTags | ||||
Contract.meta.tag:SourceClassificationTag | example | CommonTags | ||||
Contract.meta.tag:SourceClassificationTag.code | required | SourceClassificationValueSet (a valid code from Classification of the origin of data) | ||||
Contract.language | preferred | CommonLanguages
| ||||
Contract.identifier:key.use | required | IdentifierUse | ||||
Contract.identifier:key.type | extensible | Pattern: ADKEY | ||||
Contract.identifier:customerId.use | required | IdentifierUse | ||||
Contract.identifier:customerId.type | extensible | Pattern: CUSTKEY | ||||
Contract.status | required | ContractResourceStatusCodes | ||||
Contract.legalState | extensible | ContractResourceLegalStateCodes | ||||
Contract.contentDerivative | example | ContractContentDerivationCodes | ||||
Contract.expirationType | example | ContractResourceExpirationTypeCodes | ||||
Contract.scope | example | ContractResourceScopeCodes | ||||
Contract.type | example | ContractTypeCodes | ||||
Contract.subType | example | ContractSubtypeCodes | ||||
Contract.contentDefinition.type | example | ContractResourceDefinitionTypeCodes | ||||
Contract.contentDefinition.subType | example | ContractResourceDefinitionSubtypeCodes | ||||
Contract.contentDefinition.publicationStatus | required | ContractResourcePublicationStatusCodes | ||||
Contract.term.type | example | ContractTermTypeCodes | ||||
Contract.term.subType | example | ContractTermSubtypeCodes | ||||
Contract.term.securityLabel.classification | example | ContractResourceScopeCodes | ||||
Contract.term.securityLabel.category | example | ContractResourceScopeCodes | ||||
Contract.term.securityLabel.control | example | ContractResourceSecurityControlCodes | ||||
Contract.term.offer.party.role | example | ContractResourcePartyRoleCodes | ||||
Contract.term.offer.type | example | ContractTermTypeCodes | ||||
Contract.term.offer.decision | extensible | ActConsentDirective | ||||
Contract.term.offer.decisionMode | example | ContractResourceDecisionModeCodes | ||||
Contract.term.asset.scope | example | ContractResourceAssetScopeCodes | ||||
Contract.term.asset.type | example | ContractResourceAssetTypeCodes | ||||
Contract.term.asset.subtype | example | ContractResourceAssetSub-TypeCodes | ||||
Contract.term.asset.relationship | extensible | ConsentContentClass | ||||
Contract.term.asset.context.code | example | ContractResourceAssetContextCodes | ||||
Contract.term.asset.periodType | example | ContractResourceAssetAvailiabilityCodes | ||||
Contract.term.action.type | example | ContractActionCodes | ||||
Contract.term.action.subject.role | example | ContractActorRoleCodes | ||||
Contract.term.action.intent | example | PurposeOfUse | ||||
Contract.term.action.status | example | ContractResourceActionStatusCodes | ||||
Contract.term.action.performerType | example | ProvenanceParticipantType | ||||
Contract.term.action.performerRole | example | ProvenanceParticipantRole | ||||
Contract.term.action.reasonCode | example | PurposeOfUse | ||||
Contract.signer.type | preferred | ContractSignerTypeCodes |
This structure is derived from Contract
Summary
Mandatory: 9 elements (1 nested mandatory element)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron