Onyx Consent Authorization SAFHIR Implementation and Operations Guide
0.0.2 - ci-build

Onyx Consent Authorization SAFHIR Implementation and Operations Guide - Local Development build (v0.0.2). See the Directory of published versions

Resource Profile: ApiContract

Defining URL:http://ig.fhir.safhir.io/ig/safhir-ocasio/StructureDefinition/ApiContract
Version:0.0.2
Name:ApiContract
Status:Active as of 2021-11-29T21:14:01+00:00
Definition:

Contract document that defines the terms for access to an API set such as the CARIN Blue Button API or other Implementations that fall within the CMS Patient Access API

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://ig.fhir.safhir.io/ig/safhir-ocasio/StructureDefinition/ApiContract

Example Contract Resources

Examples are provided if Contracts for each of the CMS Patient Access APIs plus the Da Vinci Plan-Net API.

Formal Views of Profile Content

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

This structure is derived from Contract

Summary

Mandatory: 4 elements
Must-Support: 6 elements

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... status S0..1codeAn executed set of terms for access to the set of APIs to meet a specific requirement
... legalState S0..1CodeableConceptExecuted - the terms of engagement with the API.
... issued S1..1dateTimeWhen this Contract was issued
... name S1..1stringDescription of access control
... author S1..1Reference(Patient | Practitioner | PractitionerRole | Organization)Reference to the organization originating the API controls. Typically the dataholder.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierContract number
... url 0..1uriBasal definition
... version Σ0..1stringBusiness edition
... status ?!SΣ0..1codeAn executed set of terms for access to the set of APIs to meet a specific requirement
Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance.

... legalState S0..1CodeableConceptExecuted - the terms of engagement with the API.
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 SΣ1..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 S1..1Reference(Organization)The DataHolder organization that is defining the API access requirements
... domain 0..*Reference(Location)A sphere of control governed by an authoritative jurisdiction, organization, or person
... site 0..*Reference(Location)Specific Location
... name SΣ1..1stringDescription of access control
... title Σ0..1stringHuman Friendly name
... subtitle 0..1stringSubordinate Friendly name
... alias 0..*stringAcronym or short name
... author S1..1Reference(Patient | Practitioner | PractitionerRole | Organization)Reference to the organization originating the API controls. Typically the dataholder.
... 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
... supportingInfo 0..*Reference(Resource)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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... status ?!Σ0..1codeAn executed set of terms for access to the set of APIs to meet a specific requirement
Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance.

... legalState 0..1CodeableConceptExecuted - the terms of engagement with the API.
Binding: ContractResourceLegalStateCodes (extensible): Detailed codes for the legal state of a contract.

... issued Σ1..1dateTimeWhen this Contract was issued
... name Σ1..1stringDescription of access control
... author 1..1Reference(Patient | Practitioner | PractitionerRole | Organization)Reference to the organization originating the API controls. Typically the dataholder.

doco Documentation for this format

This structure is derived from Contract

Summary

Mandatory: 4 elements
Must-Support: 6 elements

Differential View

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... status S0..1codeAn executed set of terms for access to the set of APIs to meet a specific requirement
... legalState S0..1CodeableConceptExecuted - the terms of engagement with the API.
... issued S1..1dateTimeWhen this Contract was issued
... name S1..1stringDescription of access control
... author S1..1Reference(Patient | Practitioner | PractitionerRole | Organization)Reference to the organization originating the API controls. Typically the dataholder.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractLegal Agreement
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierContract number
... url 0..1uriBasal definition
... version Σ0..1stringBusiness edition
... status ?!SΣ0..1codeAn executed set of terms for access to the set of APIs to meet a specific requirement
Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance.

... legalState S0..1CodeableConceptExecuted - the terms of engagement with the API.
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 SΣ1..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 S1..1Reference(Organization)The DataHolder organization that is defining the API access requirements
... domain 0..*Reference(Location)A sphere of control governed by an authoritative jurisdiction, organization, or person
... site 0..*Reference(Location)Specific Location
... name SΣ1..1stringDescription of access control
... title Σ0..1stringHuman Friendly name
... subtitle 0..1stringSubordinate Friendly name
... alias 0..*stringAcronym or short name
... author S1..1Reference(Patient | Practitioner | PractitionerRole | Organization)Reference to the organization originating the API controls. Typically the dataholder.
... 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
... supportingInfo 0..*Reference(Resource)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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Contract.languagepreferredCommonLanguages
Max Binding: AllLanguages
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