LinuxForHealth FHIR Implementation Guide
8.0.0 - draft United States of America flag

LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions

Resource Profile: Fee for Value Initative

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... meta 0..1ProcessMetaMetadata about a resource
.... profile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... contained 0..0
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... ffvSchedule 1..1CodeableConceptSchedule 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..*IdentifierContract number
Slice: Ordered, Open by pattern:type
.... identifier:key 1..1IdentifierContract number
..... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ADKEY
.... identifier:customerId 1..1IdentifierContract number
..... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CUSTKEY
... title 1..1stringHuman Friendly name
... Slices for supportingInfo 2..*Reference(Resource)Extra Information
Slice: Ordered, Open by pattern:type
.... supportingInfo:participatingProviders 1..1Reference(Practitioner List)Extra Information
.... supportingInfo:excludedPatients 1..1Reference(Patient List)Extra Information
.... supportingInfo:includedPatients 0..1Reference(Patient List)Extra Information

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... meta 0..1ProcessMetaMetadata about a resource
.... ingestionBatchId 0..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..*IdentifierThe 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..1dateTimeThe timestamp when the data was generated within the FHIR resource or element
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp
.... sourceRecordId 0..*stringThe 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..*stringThe 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..1CodeableConceptEither the data model type or schema type that generates this FHIR resource
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-type
.... sourceDataModelVersion 0..1stringVersion 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..1CodeableConceptThe 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..1uri"http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger"
..... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: hl7VS-eventTypeCode (example)
.... sourceEventTimestamp 0..1dateTimeDate 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..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... Slices for tag Σ0..*CodingTags 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..1CodingIdentifies 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..1uriIdentity of the terminology system
Required Pattern: http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... ffvSchedule 1..1CodeableConceptSchedule 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..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ2..*IdentifierContract number
Slice: Ordered, Open by pattern:type
.... identifier:key Σ1..1IdentifierContract number
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ADKEY
.... identifier:customerId Σ1..1IdentifierContract number
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CUSTKEY
... status ?!Σ0..1codeamended | 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..1stringHuman Friendly name
... Slices for supportingInfo 2..*Reference(Resource)Extra Information
Slice: Ordered, Open by pattern:type
.... supportingInfo:participatingProviders 1..1Reference(Practitioner List)Extra Information
.... supportingInfo:excludedPatients 1..1Reference(Patient List)Extra Information
.... supportingInfo:includedPatients 0..1Reference(Patient List)Extra Information

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Contract.meta.extension:sourceEventTrigger.value[x]:valueCodeableConceptexampleHl7VSEventTypeCode
Contract.meta.tagexampleCommonTags
Contract.meta.tag:SourceClassificationTagexampleCommonTags
Contract.identifier:key.userequiredIdentifierUse
Contract.identifier:key.typeextensiblePattern: ADKEY
Contract.identifier:customerId.userequiredIdentifierUse
Contract.identifier:customerId.typeextensiblePattern: CUSTKEY
Contract.statusrequiredContractResourceStatusCodes
NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... id Σ0..1idLogical id of this artifact
... meta 0..1ProcessMetaMetadata about a resource
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... ingestionBatchId 0..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..*IdentifierThe 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..1dateTimeThe timestamp when the data was generated within the FHIR resource or element
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp
.... sourceRecordId 0..*stringThe 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..*stringThe 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..1CodeableConceptEither the data model type or schema type that generates this FHIR resource
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-type
.... sourceDataModelVersion 0..1stringVersion 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..1CodeableConceptThe event that is the catalyst for creating or updating this FHIR resource
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger"
..... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: hl7VS-eventTypeCode (example)
.... sourceEventTimestamp 0..1dateTimeDate 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..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags 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..1CodingIdentifies 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Binding: Source Classification Value Set (required)
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... attributionCode 1..1CodeableConceptFFV initiative attribution method code
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/attribution-code
Binding: Attribution Codes (required)
... ffvSchedule 1..1CodeableConceptSchedule 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..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ2..*IdentifierContract number
Slice: Ordered, Open by pattern:type
.... identifier:key Σ1..1IdentifierContract number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ADKEY
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:customerId Σ1..1IdentifierContract number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CUSTKEY
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... url 0..1uriBasal definition
... version Σ0..1stringBusiness edition
... status ?!Σ0..1codeamended | 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..1CodeableConceptNegotiation status
Binding: ContractResourceLegalStateCodes (extensible): Detailed codes for the legal state of a contract.

... instantiatesCanonical 0..1Reference(Contract)Source Contract Definition
... instantiatesUri 0..1uriExternal Contract Definition
... contentDerivative 0..1CodeableConceptContent 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..1dateTimeWhen this Contract was issued
... applies Σ0..1PeriodEffective time
... expirationType 0..1CodeableConceptContract 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..1stringComputer friendly designation
... title Σ1..1stringHuman Friendly name
... subtitle 0..1stringSubordinate Friendly name
... alias 0..*stringAcronym or short name
... author 0..1Reference(Patient | Practitioner | PractitionerRole | Organization)Source of Contract
... scope 0..1CodeableConceptRange of Legal Concerns
Binding: ContractResourceScopeCodes (example): Codes for the range of legal concerns.

... topic[x] 0..1Focus of contract interest
.... topicCodeableConceptCodeableConcept
.... topicReferenceReference(Resource)
... type Σ0..1CodeableConceptLegal instrument category
Binding: ContractTypeCodes (example): List of overall contract codes.

... subType Σ0..*CodeableConceptSubtype within the context of type
Binding: ContractSubtypeCodes (example): Detailed codes within the above.


... contentDefinition 0..1BackboneElementContract precursor content
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptContent structure and use
Binding: ContractResourceDefinitionTypeCodes (example): Detailed codes for the definition of contracts.

.... subType 0..1CodeableConceptDetailed Content Type Definition
Binding: ContractResourceDefinitionSubtypeCodes (example): Detailed codes for the additional definition of contracts.

.... publisher 0..1Reference(Practitioner | PractitionerRole | Organization)Publisher Entity
.... publicationDate 0..1dateTimeWhen published
.... publicationStatus 1..1codeamended | 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..1markdownPublication Ownership
... term 0..*BackboneElementContract Term List
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..1IdentifierContract Term Number
.... issued Σ0..1dateTimeContract Term Issue Date Time
.... applies Σ0..1PeriodContract Term Effective Time
.... topic[x] 0..1Term Concern
..... topicCodeableConceptCodeableConcept
..... topicReferenceReference(Resource)
.... type 0..1CodeableConceptContract Term Type or Form
Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions.

.... subType 0..1CodeableConceptContract Term Type specific classification
Binding: ContractTermSubtypeCodes (example): Detailed codes for the subtypes of contract provisions.

.... text Σ0..1stringTerm Statement
.... securityLabel 0..*BackboneElementProtection for the Term
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... number 0..*unsignedIntLink to Security Labels
..... classification 1..1CodingConfidentiality Protection
Binding: ContractResourceScopeCodes (example): Codes for confidentiality protection.

..... category 0..*CodingApplicable Policy
Binding: ContractResourceScopeCodes (example): Codes for policy category.


..... control 0..*CodingHandling Instructions
Binding: ContractResourceSecurityControlCodes (example): Codes for handling instructions.


.... offer 1..1BackboneElementContext of the Contract term
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... identifier 0..*IdentifierOffer business ID
..... party 0..*BackboneElementOffer Recipient
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... reference 1..*Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization)Referenced entity
...... role 1..1CodeableConceptParticipant engagement type
Binding: ContractResourcePartyRoleCodes (example): Codes for offer participant roles.

..... topic Σ0..1Reference(Resource)Negotiable offer asset
..... type 0..1CodeableConceptContract Offer Type or Form
Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions.

..... decision 0..1CodeableConceptAccepting party choice
Binding: ActConsentDirective (extensible): The type of decision made by a grantor with respect to an offer made by a grantee.

..... decisionMode 0..*CodeableConceptHow decision is conveyed
Binding: ContractResourceDecisionModeCodes (example): Codes for conveying a decision.


..... answer 0..*BackboneElementResponse to offer text
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... value[x] 1..1The actual answer response
....... valueBooleanboolean
....... valueDecimaldecimal
....... valueIntegerinteger
....... valueDatedate
....... valueDateTimedateTime
....... valueTimetime
....... valueStringstring
....... valueUriuri
....... valueAttachmentAttachment
....... valueCodingCoding
....... valueQuantityQuantity
....... valueReferenceReference(Resource)
..... text 0..1stringHuman readable offer text
..... linkId 0..*stringPointer to text
..... securityLabelNumber 0..*unsignedIntOffer restriction numbers
.... asset 0..*BackboneElementContract Term Asset List
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... scope 0..1CodeableConceptRange of asset
Binding: ContractResourceAssetScopeCodes (example): Codes for scoping an asset.

..... type 0..*CodeableConceptAsset category
Binding: ContractResourceAssetTypeCodes (example): Condes for the type of an asset.


..... typeReference 0..*Reference(Resource)Associated entities
..... subtype 0..*CodeableConceptAsset sub-category
Binding: ContractResourceAssetSub-TypeCodes (example): Condes for the sub-type of an asset.


..... relationship 0..1CodingKinship of the asset
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.

..... context 0..*BackboneElementCircumstance of the asset
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... reference 0..1Reference(Resource)Creator,custodian or owner
...... code 0..*CodeableConceptCodeable asset context
Binding: ContractResourceAssetContextCodes (example): Codes for the context of the asset.


...... text 0..1stringContext description
..... condition 0..1stringQuality desctiption of asset
..... periodType 0..*CodeableConceptAsset availability types
Binding: ContractResourceAssetAvailiabilityCodes (example): Codes for asset availability.


..... period 0..*PeriodTime period of the asset
..... usePeriod 0..*PeriodTime period
..... text 0..1stringAsset clause or question text
..... linkId 0..*stringPointer to asset text
..... answer 0..*See answer (Contract)Response to assets
..... securityLabelNumber 0..*unsignedIntAsset restriction numbers
..... valuedItem 0..*BackboneElementContract Valued Item List
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... entity[x] 0..1Contract Valued Item Type
....... entityCodeableConceptCodeableConcept
....... entityReferenceReference(Resource)
...... identifier 0..1IdentifierContract Valued Item Number
...... effectiveTime 0..1dateTimeContract Valued Item Effective Tiem
...... quantity 0..1SimpleQuantityCount of Contract Valued Items
...... unitPrice 0..1MoneyContract Valued Item fee, charge, or cost
...... factor 0..1decimalContract Valued Item Price Scaling Factor
...... points 0..1decimalContract Valued Item Difficulty Scaling Factor
...... net 0..1MoneyTotal Contract Valued Item Value
...... payment 0..1stringTerms of valuation
...... paymentDate 0..1dateTimeWhen payment is due
...... responsible 0..1Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who will make payment
...... recipient 0..1Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who will receive payment
...... linkId 0..*stringPointer to specific item
...... securityLabelNumber 0..*unsignedIntSecurity Labels that define affected terms
.... action 0..*BackboneElementEntity being ascribed responsibility
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... doNotPerform ?!0..1booleanTrue if the term prohibits the action
..... type 1..1CodeableConceptType or form of the action
Binding: ContractActionCodes (example): Detailed codes for the contract action.

..... subject 0..*BackboneElementEntity of the action
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... reference 1..*Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization)Entity of the action
...... role 0..1CodeableConceptRole type of the agent
Binding: ContractActorRoleCodes (example): Detailed codes for the contract actor role.

..... intent 1..1CodeableConceptPurpose for the Contract Term Action
Binding: PurposeOfUse (example): Detailed codes for the contract action reason.

..... linkId 0..*stringPointer to specific item
..... status 1..1CodeableConceptState of the action
Binding: ContractResourceActionStatusCodes (example): Codes for the status of an term action.

..... context 0..1Reference(Encounter | EpisodeOfCare)Episode associated with action
..... contextLinkId 0..*stringPointer to specific item
..... occurrence[x] 0..1When action happens
...... occurrenceDateTimedateTime
...... occurrencePeriodPeriod
...... occurrenceTimingTiming
..... requester 0..*Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization)Who asked for action
..... requesterLinkId 0..*stringPointer to specific item
..... performerType 0..*CodeableConceptKind of service performer
Binding: ProvenanceParticipantType (example): Codes for the types of action perfomer.


..... performerRole 0..1CodeableConceptCompetency of the performer
Binding: ProvenanceParticipantRole (example): Codes for the role of the action performer.

..... performer 0..1Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location)Actor that wil execute (or not) the action
..... performerLinkId 0..*stringPointer to specific item
..... reasonCode 0..*CodeableConceptWhy 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..*stringWhy action is to be performed
..... reasonLinkId 0..*stringPointer to specific item
..... note 0..*AnnotationComments about the action
..... securityLabelNumber 0..*unsignedIntAction 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..1Reference(Practitioner List)Extra Information
.... supportingInfo:excludedPatients 1..1Reference(Patient List)Extra Information
.... supportingInfo:includedPatients 0..1Reference(Patient List)Extra Information
... relevantHistory 0..*Reference(Provenance)Key event in Contract History
... signer 0..*BackboneElementContract Signatory
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodingContract Signatory Role
Binding: ContractSignerTypeCodes (preferred): List of parties who may be signing.

.... party 1..1Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Contract Signatory Party
.... signature 1..*SignatureContract Documentation Signature
... friendly 0..*BackboneElementContract Friendly Language
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Easily comprehended representation of this Contract
..... contentAttachmentAttachment
..... contentReferenceReference(Composition | DocumentReference | QuestionnaireResponse)
... legal 0..*BackboneElementContract Legal Language
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Contract Legal Text
..... contentAttachmentAttachment
..... contentReferenceReference(Composition | DocumentReference | QuestionnaireResponse)
... rule 0..*BackboneElementComputable Contract Language
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Computable Contract Rules
..... contentAttachmentAttachment
..... contentReferenceReference(DocumentReference)
... legallyBinding[x] 0..1Binding Contract
.... legallyBindingAttachmentAttachment
.... legallyBindingReferenceReference(Composition | DocumentReference | QuestionnaireResponse | Contract)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Contract.meta.extension:sourceEventTrigger.value[x]:valueCodeableConceptexampleHl7VSEventTypeCode
Contract.meta.securityextensibleAll Security Labels
Contract.meta.tagexampleCommonTags
Contract.meta.tag:SourceClassificationTagexampleCommonTags
Contract.meta.tag:SourceClassificationTag.coderequiredSourceClassificationValueSet (a valid code from Classification of the origin of data)
Contract.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Contract.identifier:key.userequiredIdentifierUse
Contract.identifier:key.typeextensiblePattern: ADKEY
Contract.identifier:customerId.userequiredIdentifierUse
Contract.identifier:customerId.typeextensiblePattern: CUSTKEY
Contract.statusrequiredContractResourceStatusCodes
Contract.legalStateextensibleContractResourceLegalStateCodes
Contract.contentDerivativeexampleContractContentDerivationCodes
Contract.expirationTypeexampleContractResourceExpirationTypeCodes
Contract.scopeexampleContractResourceScopeCodes
Contract.typeexampleContractTypeCodes
Contract.subTypeexampleContractSubtypeCodes
Contract.contentDefinition.typeexampleContractResourceDefinitionTypeCodes
Contract.contentDefinition.subTypeexampleContractResourceDefinitionSubtypeCodes
Contract.contentDefinition.publicationStatusrequiredContractResourcePublicationStatusCodes
Contract.term.typeexampleContractTermTypeCodes
Contract.term.subTypeexampleContractTermSubtypeCodes
Contract.term.securityLabel.classificationexampleContractResourceScopeCodes
Contract.term.securityLabel.categoryexampleContractResourceScopeCodes
Contract.term.securityLabel.controlexampleContractResourceSecurityControlCodes
Contract.term.offer.party.roleexampleContractResourcePartyRoleCodes
Contract.term.offer.typeexampleContractTermTypeCodes
Contract.term.offer.decisionextensibleActConsentDirective
Contract.term.offer.decisionModeexampleContractResourceDecisionModeCodes
Contract.term.asset.scopeexampleContractResourceAssetScopeCodes
Contract.term.asset.typeexampleContractResourceAssetTypeCodes
Contract.term.asset.subtypeexampleContractResourceAssetSub-TypeCodes
Contract.term.asset.relationshipextensibleConsentContentClass
Contract.term.asset.context.codeexampleContractResourceAssetContextCodes
Contract.term.asset.periodTypeexampleContractResourceAssetAvailiabilityCodes
Contract.term.action.typeexampleContractActionCodes
Contract.term.action.subject.roleexampleContractActorRoleCodes
Contract.term.action.intentexamplePurposeOfUse
Contract.term.action.statusexampleContractResourceActionStatusCodes
Contract.term.action.performerTypeexampleProvenanceParticipantType
Contract.term.action.performerRoleexampleProvenanceParticipantRole
Contract.term.action.reasonCodeexamplePurposeOfUse
Contract.signer.typepreferredContractSignerTypeCodes

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:

  • The element Contract.identifier is sliced based on the value of pattern:type (ordered)
  • The element Contract.supportingInfo is sliced based on the value of pattern:type (ordered)

Differential View

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... meta 0..1ProcessMetaMetadata about a resource
.... profile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... contained 0..0
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... ffvSchedule 1..1CodeableConceptSchedule 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..*IdentifierContract number
Slice: Ordered, Open by pattern:type
.... identifier:key 1..1IdentifierContract number
..... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ADKEY
.... identifier:customerId 1..1IdentifierContract number
..... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CUSTKEY
... title 1..1stringHuman Friendly name
... Slices for supportingInfo 2..*Reference(Resource)Extra Information
Slice: Ordered, Open by pattern:type
.... supportingInfo:participatingProviders 1..1Reference(Practitioner List)Extra Information
.... supportingInfo:excludedPatients 1..1Reference(Patient List)Extra Information
.... supportingInfo:includedPatients 0..1Reference(Patient List)Extra Information

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... meta 0..1ProcessMetaMetadata about a resource
.... ingestionBatchId 0..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..*IdentifierThe 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..1dateTimeThe timestamp when the data was generated within the FHIR resource or element
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp
.... sourceRecordId 0..*stringThe 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..*stringThe 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..1CodeableConceptEither the data model type or schema type that generates this FHIR resource
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-type
.... sourceDataModelVersion 0..1stringVersion 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..1CodeableConceptThe 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..1uri"http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger"
..... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: hl7VS-eventTypeCode (example)
.... sourceEventTimestamp 0..1dateTimeDate 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..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... Slices for tag Σ0..*CodingTags 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..1CodingIdentifies 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..1uriIdentity of the terminology system
Required Pattern: http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... ffvSchedule 1..1CodeableConceptSchedule 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..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ2..*IdentifierContract number
Slice: Ordered, Open by pattern:type
.... identifier:key Σ1..1IdentifierContract number
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ADKEY
.... identifier:customerId Σ1..1IdentifierContract number
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CUSTKEY
... status ?!Σ0..1codeamended | 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..1stringHuman Friendly name
... Slices for supportingInfo 2..*Reference(Resource)Extra Information
Slice: Ordered, Open by pattern:type
.... supportingInfo:participatingProviders 1..1Reference(Practitioner List)Extra Information
.... supportingInfo:excludedPatients 1..1Reference(Patient List)Extra Information
.... supportingInfo:includedPatients 0..1Reference(Patient List)Extra Information

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Contract.meta.extension:sourceEventTrigger.value[x]:valueCodeableConceptexampleHl7VSEventTypeCode
Contract.meta.tagexampleCommonTags
Contract.meta.tag:SourceClassificationTagexampleCommonTags
Contract.identifier:key.userequiredIdentifierUse
Contract.identifier:key.typeextensiblePattern: ADKEY
Contract.identifier:customerId.userequiredIdentifierUse
Contract.identifier:customerId.typeextensiblePattern: CUSTKEY
Contract.statusrequiredContractResourceStatusCodes

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... id Σ0..1idLogical id of this artifact
... meta 0..1ProcessMetaMetadata about a resource
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... ingestionBatchId 0..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..1stringThe 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..*IdentifierThe 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..1dateTimeThe timestamp when the data was generated within the FHIR resource or element
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp
.... sourceRecordId 0..*stringThe 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..*stringThe 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..1CodeableConceptEither the data model type or schema type that generates this FHIR resource
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-record-type
.... sourceDataModelVersion 0..1stringVersion 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..1CodeableConceptThe event that is the catalyst for creating or updating this FHIR resource
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger"
..... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: hl7VS-eventTypeCode (example)
.... sourceEventTimestamp 0..1dateTimeDate 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..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags 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..1CodingIdentifies 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Binding: Source Classification Value Set (required)
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... attributionCode 1..1CodeableConceptFFV initiative attribution method code
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/attribution-code
Binding: Attribution Codes (required)
... ffvSchedule 1..1CodeableConceptSchedule 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..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ2..*IdentifierContract number
Slice: Ordered, Open by pattern:type
.... identifier:key Σ1..1IdentifierContract number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ADKEY
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:customerId Σ1..1IdentifierContract number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: CUSTKEY
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... url 0..1uriBasal definition
... version Σ0..1stringBusiness edition
... status ?!Σ0..1codeamended | 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..1CodeableConceptNegotiation status
Binding: ContractResourceLegalStateCodes (extensible): Detailed codes for the legal state of a contract.

... instantiatesCanonical 0..1Reference(Contract)Source Contract Definition
... instantiatesUri 0..1uriExternal Contract Definition
... contentDerivative 0..1CodeableConceptContent 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..1dateTimeWhen this Contract was issued
... applies Σ0..1PeriodEffective time
... expirationType 0..1CodeableConceptContract 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..1stringComputer friendly designation
... title Σ1..1stringHuman Friendly name
... subtitle 0..1stringSubordinate Friendly name
... alias 0..*stringAcronym or short name
... author 0..1Reference(Patient | Practitioner | PractitionerRole | Organization)Source of Contract
... scope 0..1CodeableConceptRange of Legal Concerns
Binding: ContractResourceScopeCodes (example): Codes for the range of legal concerns.

... topic[x] 0..1Focus of contract interest
.... topicCodeableConceptCodeableConcept
.... topicReferenceReference(Resource)
... type Σ0..1CodeableConceptLegal instrument category
Binding: ContractTypeCodes (example): List of overall contract codes.

... subType Σ0..*CodeableConceptSubtype within the context of type
Binding: ContractSubtypeCodes (example): Detailed codes within the above.


... contentDefinition 0..1BackboneElementContract precursor content
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptContent structure and use
Binding: ContractResourceDefinitionTypeCodes (example): Detailed codes for the definition of contracts.

.... subType 0..1CodeableConceptDetailed Content Type Definition
Binding: ContractResourceDefinitionSubtypeCodes (example): Detailed codes for the additional definition of contracts.

.... publisher 0..1Reference(Practitioner | PractitionerRole | Organization)Publisher Entity
.... publicationDate 0..1dateTimeWhen published
.... publicationStatus 1..1codeamended | 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..1markdownPublication Ownership
... term 0..*BackboneElementContract Term List
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..1IdentifierContract Term Number
.... issued Σ0..1dateTimeContract Term Issue Date Time
.... applies Σ0..1PeriodContract Term Effective Time
.... topic[x] 0..1Term Concern
..... topicCodeableConceptCodeableConcept
..... topicReferenceReference(Resource)
.... type 0..1CodeableConceptContract Term Type or Form
Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions.

.... subType 0..1CodeableConceptContract Term Type specific classification
Binding: ContractTermSubtypeCodes (example): Detailed codes for the subtypes of contract provisions.

.... text Σ0..1stringTerm Statement
.... securityLabel 0..*BackboneElementProtection for the Term
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... number 0..*unsignedIntLink to Security Labels
..... classification 1..1CodingConfidentiality Protection
Binding: ContractResourceScopeCodes (example): Codes for confidentiality protection.

..... category 0..*CodingApplicable Policy
Binding: ContractResourceScopeCodes (example): Codes for policy category.


..... control 0..*CodingHandling Instructions
Binding: ContractResourceSecurityControlCodes (example): Codes for handling instructions.


.... offer 1..1BackboneElementContext of the Contract term
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... identifier 0..*IdentifierOffer business ID
..... party 0..*BackboneElementOffer Recipient
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... reference 1..*Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization)Referenced entity
...... role 1..1CodeableConceptParticipant engagement type
Binding: ContractResourcePartyRoleCodes (example): Codes for offer participant roles.

..... topic Σ0..1Reference(Resource)Negotiable offer asset
..... type 0..1CodeableConceptContract Offer Type or Form
Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions.

..... decision 0..1CodeableConceptAccepting party choice
Binding: ActConsentDirective (extensible): The type of decision made by a grantor with respect to an offer made by a grantee.

..... decisionMode 0..*CodeableConceptHow decision is conveyed
Binding: ContractResourceDecisionModeCodes (example): Codes for conveying a decision.


..... answer 0..*BackboneElementResponse to offer text
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... value[x] 1..1The actual answer response
....... valueBooleanboolean
....... valueDecimaldecimal
....... valueIntegerinteger
....... valueDatedate
....... valueDateTimedateTime
....... valueTimetime
....... valueStringstring
....... valueUriuri
....... valueAttachmentAttachment
....... valueCodingCoding
....... valueQuantityQuantity
....... valueReferenceReference(Resource)
..... text 0..1stringHuman readable offer text
..... linkId 0..*stringPointer to text
..... securityLabelNumber 0..*unsignedIntOffer restriction numbers
.... asset 0..*BackboneElementContract Term Asset List
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... scope 0..1CodeableConceptRange of asset
Binding: ContractResourceAssetScopeCodes (example): Codes for scoping an asset.

..... type 0..*CodeableConceptAsset category
Binding: ContractResourceAssetTypeCodes (example): Condes for the type of an asset.


..... typeReference 0..*Reference(Resource)Associated entities
..... subtype 0..*CodeableConceptAsset sub-category
Binding: ContractResourceAssetSub-TypeCodes (example): Condes for the sub-type of an asset.


..... relationship 0..1CodingKinship of the asset
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.

..... context 0..*BackboneElementCircumstance of the asset
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... reference 0..1Reference(Resource)Creator,custodian or owner
...... code 0..*CodeableConceptCodeable asset context
Binding: ContractResourceAssetContextCodes (example): Codes for the context of the asset.


...... text 0..1stringContext description
..... condition 0..1stringQuality desctiption of asset
..... periodType 0..*CodeableConceptAsset availability types
Binding: ContractResourceAssetAvailiabilityCodes (example): Codes for asset availability.


..... period 0..*PeriodTime period of the asset
..... usePeriod 0..*PeriodTime period
..... text 0..1stringAsset clause or question text
..... linkId 0..*stringPointer to asset text
..... answer 0..*See answer (Contract)Response to assets
..... securityLabelNumber 0..*unsignedIntAsset restriction numbers
..... valuedItem 0..*BackboneElementContract Valued Item List
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... entity[x] 0..1Contract Valued Item Type
....... entityCodeableConceptCodeableConcept
....... entityReferenceReference(Resource)
...... identifier 0..1IdentifierContract Valued Item Number
...... effectiveTime 0..1dateTimeContract Valued Item Effective Tiem
...... quantity 0..1SimpleQuantityCount of Contract Valued Items
...... unitPrice 0..1MoneyContract Valued Item fee, charge, or cost
...... factor 0..1decimalContract Valued Item Price Scaling Factor
...... points 0..1decimalContract Valued Item Difficulty Scaling Factor
...... net 0..1MoneyTotal Contract Valued Item Value
...... payment 0..1stringTerms of valuation
...... paymentDate 0..1dateTimeWhen payment is due
...... responsible 0..1Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who will make payment
...... recipient 0..1Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who will receive payment
...... linkId 0..*stringPointer to specific item
...... securityLabelNumber 0..*unsignedIntSecurity Labels that define affected terms
.... action 0..*BackboneElementEntity being ascribed responsibility
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... doNotPerform ?!0..1booleanTrue if the term prohibits the action
..... type 1..1CodeableConceptType or form of the action
Binding: ContractActionCodes (example): Detailed codes for the contract action.

..... subject 0..*BackboneElementEntity of the action
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... reference 1..*Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization)Entity of the action
...... role 0..1CodeableConceptRole type of the agent
Binding: ContractActorRoleCodes (example): Detailed codes for the contract actor role.

..... intent 1..1CodeableConceptPurpose for the Contract Term Action
Binding: PurposeOfUse (example): Detailed codes for the contract action reason.

..... linkId 0..*stringPointer to specific item
..... status 1..1CodeableConceptState of the action
Binding: ContractResourceActionStatusCodes (example): Codes for the status of an term action.

..... context 0..1Reference(Encounter | EpisodeOfCare)Episode associated with action
..... contextLinkId 0..*stringPointer to specific item
..... occurrence[x] 0..1When action happens
...... occurrenceDateTimedateTime
...... occurrencePeriodPeriod
...... occurrenceTimingTiming
..... requester 0..*Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization)Who asked for action
..... requesterLinkId 0..*stringPointer to specific item
..... performerType 0..*CodeableConceptKind of service performer
Binding: ProvenanceParticipantType (example): Codes for the types of action perfomer.


..... performerRole 0..1CodeableConceptCompetency of the performer
Binding: ProvenanceParticipantRole (example): Codes for the role of the action performer.

..... performer 0..1Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location)Actor that wil execute (or not) the action
..... performerLinkId 0..*stringPointer to specific item
..... reasonCode 0..*CodeableConceptWhy 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..*stringWhy action is to be performed
..... reasonLinkId 0..*stringPointer to specific item
..... note 0..*AnnotationComments about the action
..... securityLabelNumber 0..*unsignedIntAction 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..1Reference(Practitioner List)Extra Information
.... supportingInfo:excludedPatients 1..1Reference(Patient List)Extra Information
.... supportingInfo:includedPatients 0..1Reference(Patient List)Extra Information
... relevantHistory 0..*Reference(Provenance)Key event in Contract History
... signer 0..*BackboneElementContract Signatory
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodingContract Signatory Role
Binding: ContractSignerTypeCodes (preferred): List of parties who may be signing.

.... party 1..1Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Contract Signatory Party
.... signature 1..*SignatureContract Documentation Signature
... friendly 0..*BackboneElementContract Friendly Language
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Easily comprehended representation of this Contract
..... contentAttachmentAttachment
..... contentReferenceReference(Composition | DocumentReference | QuestionnaireResponse)
... legal 0..*BackboneElementContract Legal Language
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Contract Legal Text
..... contentAttachmentAttachment
..... contentReferenceReference(Composition | DocumentReference | QuestionnaireResponse)
... rule 0..*BackboneElementComputable Contract Language
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Computable Contract Rules
..... contentAttachmentAttachment
..... contentReferenceReference(DocumentReference)
... legallyBinding[x] 0..1Binding Contract
.... legallyBindingAttachmentAttachment
.... legallyBindingReferenceReference(Composition | DocumentReference | QuestionnaireResponse | Contract)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Contract.meta.extension:sourceEventTrigger.value[x]:valueCodeableConceptexampleHl7VSEventTypeCode
Contract.meta.securityextensibleAll Security Labels
Contract.meta.tagexampleCommonTags
Contract.meta.tag:SourceClassificationTagexampleCommonTags
Contract.meta.tag:SourceClassificationTag.coderequiredSourceClassificationValueSet (a valid code from Classification of the origin of data)
Contract.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Contract.identifier:key.userequiredIdentifierUse
Contract.identifier:key.typeextensiblePattern: ADKEY
Contract.identifier:customerId.userequiredIdentifierUse
Contract.identifier:customerId.typeextensiblePattern: CUSTKEY
Contract.statusrequiredContractResourceStatusCodes
Contract.legalStateextensibleContractResourceLegalStateCodes
Contract.contentDerivativeexampleContractContentDerivationCodes
Contract.expirationTypeexampleContractResourceExpirationTypeCodes
Contract.scopeexampleContractResourceScopeCodes
Contract.typeexampleContractTypeCodes
Contract.subTypeexampleContractSubtypeCodes
Contract.contentDefinition.typeexampleContractResourceDefinitionTypeCodes
Contract.contentDefinition.subTypeexampleContractResourceDefinitionSubtypeCodes
Contract.contentDefinition.publicationStatusrequiredContractResourcePublicationStatusCodes
Contract.term.typeexampleContractTermTypeCodes
Contract.term.subTypeexampleContractTermSubtypeCodes
Contract.term.securityLabel.classificationexampleContractResourceScopeCodes
Contract.term.securityLabel.categoryexampleContractResourceScopeCodes
Contract.term.securityLabel.controlexampleContractResourceSecurityControlCodes
Contract.term.offer.party.roleexampleContractResourcePartyRoleCodes
Contract.term.offer.typeexampleContractTermTypeCodes
Contract.term.offer.decisionextensibleActConsentDirective
Contract.term.offer.decisionModeexampleContractResourceDecisionModeCodes
Contract.term.asset.scopeexampleContractResourceAssetScopeCodes
Contract.term.asset.typeexampleContractResourceAssetTypeCodes
Contract.term.asset.subtypeexampleContractResourceAssetSub-TypeCodes
Contract.term.asset.relationshipextensibleConsentContentClass
Contract.term.asset.context.codeexampleContractResourceAssetContextCodes
Contract.term.asset.periodTypeexampleContractResourceAssetAvailiabilityCodes
Contract.term.action.typeexampleContractActionCodes
Contract.term.action.subject.roleexampleContractActorRoleCodes
Contract.term.action.intentexamplePurposeOfUse
Contract.term.action.statusexampleContractResourceActionStatusCodes
Contract.term.action.performerTypeexampleProvenanceParticipantType
Contract.term.action.performerRoleexampleProvenanceParticipantRole
Contract.term.action.reasonCodeexamplePurposeOfUse
Contract.signer.typepreferredContractSignerTypeCodes

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:

  • The element Contract.identifier is sliced based on the value of pattern:type (ordered)
  • The element Contract.supportingInfo is sliced based on the value of pattern:type (ordered)

 

Other representations of profile: CSV, Excel, Schematron