Implementationsguide for business and organization for Swedish health- and social care national digital infrastructure
0.1.0 - ci-build
Implementationsguide for business and organization for Swedish health- and social care national digital infrastructure, published by E-hälsomyndigheten (Swedish eHealth Agency). This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/danka74/verksamhet-och-organisation/ and changes regularly. See the Directory of published versions
Official URL: http://electronichealth.se/fhir/katalog/StructureDefinition/sendi-contract | Version: 0.1.0 | |||
Active as of 2024-09-06 | Computable Name: SENDIContract |
Contract profile for SENDI
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Contract
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Contract | 0..* | Contract | Legal Agreement | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contact | S | 0..1 | (Complex) | SENDIContactExtension URL: http://electronichealth.se/fhir/katalog/StructureDefinition/sendi-contact-extension |
identifier | S | 1..* | Identifier | Contract number |
status | S | 1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated |
applies | S | 1..1 | Period | Effective time |
subject | S | 1..* | Reference(SENDI OrganizationAffiliation) | Contract Target Entity |
type | S | 1..1 | CodeableConcept | Legal instrument category |
subType | S | 1..1 | CodeableConcept | Subtype within the context of type |
term | S | 1..1 | BackboneElement | Contract Term List |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Contract | 0..* | Contract | Legal Agreement | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contact | S | 0..1 | (Complex) | SENDIContactExtension URL: http://electronichealth.se/fhir/katalog/StructureDefinition/sendi-contact-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | Contract number |
status | ?!SΣ | 1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance. |
applies | SΣ | 1..1 | Period | Effective time |
subject | SΣ | 1..* | Reference(SENDI OrganizationAffiliation) | Contract Target Entity |
type | SΣ | 1..1 | CodeableConcept | Legal instrument category Binding: ContractTypeCodes (example): List of overall contract codes. |
subType | SΣ | 1..1 | CodeableConcept | Subtype within the context of type Binding: ContractSubtypeCodes (example): Detailed codes within the above. |
term | S | 1..1 | BackboneElement | Contract Term List |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
offer | 1..1 | BackboneElement | Context of the Contract term | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1 from the FHIR Standard | |
Contract.type | example | ContractTypeCodeshttp://hl7.org/fhir/ValueSet/contract-type from the FHIR Standard | |
Contract.subType | example | ContractSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-subtype from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Contract | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Contract | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Contract | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Contract | 0..* | Contract | Legal Agreement | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
contact | S | 0..1 | (Complex) | SENDIContactExtension URL: http://electronichealth.se/fhir/katalog/StructureDefinition/sendi-contact-extension | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | Contract number | ||||
url | 0..1 | uri | Basal definition | |||||
version | Σ | 0..1 | string | Business edition | ||||
status | ?!SΣ | 1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
legalState | 0..1 | CodeableConcept | Negotiation status Binding: ContractResourceLegalStateCodes (extensible): Detailed codes for the legal state of a contract. | |||||
instantiatesCanonical | 0..1 | Reference(Contract) | Source Contract Definition | |||||
instantiatesUri | 0..1 | uri | External Contract Definition | |||||
contentDerivative | 0..1 | CodeableConcept | Content derived from the basal information Binding: ContractContentDerivationCodes (example): This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source. | |||||
issued | Σ | 0..1 | dateTime | When this Contract was issued | ||||
applies | SΣ | 1..1 | Period | Effective time | ||||
expirationType | 0..1 | CodeableConcept | Contract cessation cause Binding: ContractResourceExpirationTypeCodes (example): Codes for the Cessation of Contracts. | |||||
subject | SΣ | 1..* | Reference(SENDI OrganizationAffiliation) | Contract Target Entity | ||||
authority | 0..* | Reference(Organization) | Authority under which this Contract has standing | |||||
domain | 0..* | Reference(Location) | A sphere of control governed by an authoritative jurisdiction, organization, or person | |||||
site | 0..* | Reference(Location) | Specific Location | |||||
name | Σ | 0..1 | string | Computer friendly designation | ||||
title | Σ | 0..1 | string | Human Friendly name | ||||
subtitle | 0..1 | string | Subordinate Friendly name | |||||
alias | 0..* | string | Acronym or short name | |||||
author | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Organization) | Source of Contract | |||||
scope | 0..1 | CodeableConcept | Range of Legal Concerns Binding: ContractResourceScopeCodes (example): Codes for the range of legal concerns. | |||||
topic[x] | 0..1 | Focus of contract interest | ||||||
topicCodeableConcept | CodeableConcept | |||||||
topicReference | Reference(Resource) | |||||||
type | SΣ | 1..1 | CodeableConcept | Legal instrument category Binding: ContractTypeCodes (example): List of overall contract codes. | ||||
subType | SΣ | 1..1 | CodeableConcept | Subtype within the context of type Binding: ContractSubtypeCodes (example): Detailed codes within the above. | ||||
contentDefinition | 0..1 | BackboneElement | Contract precursor content | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Content structure and use Binding: ContractResourceDefinitionTypeCodes (example): Detailed codes for the definition of contracts. | |||||
subType | 0..1 | CodeableConcept | Detailed Content Type Definition Binding: ContractResourceDefinitionSubtypeCodes (example): Detailed codes for the additional definition of contracts. | |||||
publisher | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Publisher Entity | |||||
publicationDate | 0..1 | dateTime | When published | |||||
publicationStatus | 1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourcePublicationStatusCodes (required): Status of the publication of contract content. | |||||
copyright | 0..1 | markdown | Publication Ownership | |||||
term | S | 1..1 | BackboneElement | Contract Term List | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | Σ | 0..1 | Identifier | Contract Term Number | ||||
issued | Σ | 0..1 | dateTime | Contract Term Issue Date Time | ||||
applies | Σ | 0..1 | Period | Contract Term Effective Time | ||||
topic[x] | 0..1 | Term Concern | ||||||
topicCodeableConcept | CodeableConcept | |||||||
topicReference | Reference(Resource) | |||||||
type | 0..1 | CodeableConcept | Contract Term Type or Form Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions. | |||||
subType | 0..1 | CodeableConcept | Contract Term Type specific classification Binding: ContractTermSubtypeCodes (example): Detailed codes for the subtypes of contract provisions. | |||||
text | Σ | 0..1 | string | Term Statement | ||||
securityLabel | 0..* | BackboneElement | Protection for the Term | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
number | 0..* | unsignedInt | Link to Security Labels | |||||
classification | 1..1 | Coding | Confidentiality Protection Binding: ContractResourceScopeCodes (example): Codes for confidentiality protection. | |||||
category | 0..* | Coding | Applicable Policy Binding: ContractResourceScopeCodes (example): Codes for policy category. | |||||
control | 0..* | Coding | Handling Instructions Binding: ContractResourceSecurityControlCodes (example): Codes for handling instructions. | |||||
offer | 1..1 | BackboneElement | Context of the Contract term | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | 0..* | Identifier | Offer business ID | |||||
party | 0..* | BackboneElement | Offer Recipient | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
reference | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | Referenced entity | |||||
role | 1..1 | CodeableConcept | Participant engagement type Binding: ContractResourcePartyRoleCodes (example): Codes for offer participant roles. | |||||
topic | Σ | 0..1 | Reference(Resource) | Negotiable offer asset | ||||
type | 0..1 | CodeableConcept | Contract Offer Type or Form Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions. | |||||
decision | 0..1 | CodeableConcept | Accepting party choice Binding: ActConsentDirective (extensible): The type of decision made by a grantor with respect to an offer made by a grantee. | |||||
decisionMode | 0..* | CodeableConcept | How decision is conveyed Binding: ContractResourceDecisionModeCodes (example): Codes for conveying a decision. | |||||
answer | 0..* | BackboneElement | Response to offer text | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 1..1 | The actual answer response | ||||||
valueBoolean | boolean | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueUri | uri | |||||||
valueAttachment | Attachment | |||||||
valueCoding | Coding | |||||||
valueQuantity | Quantity | |||||||
valueReference | Reference(Resource) | |||||||
text | 0..1 | string | Human readable offer text | |||||
linkId | 0..* | string | Pointer to text | |||||
securityLabelNumber | 0..* | unsignedInt | Offer restriction numbers | |||||
asset | 0..* | BackboneElement | Contract Term Asset List | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
scope | 0..1 | CodeableConcept | Range of asset Binding: ContractResourceAssetScopeCodes (example): Codes for scoping an asset. | |||||
type | 0..* | CodeableConcept | Asset category Binding: ContractResourceAssetTypeCodes (example): Condes for the type of an asset. | |||||
typeReference | 0..* | Reference(Resource) | Associated entities | |||||
subtype | 0..* | CodeableConcept | Asset sub-category Binding: ContractResourceAssetSub-TypeCodes (example): Condes for the sub-type of an asset. | |||||
relationship | 0..1 | Coding | Kinship of the asset Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |||||
context | 0..* | BackboneElement | Circumstance of the asset | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
reference | 0..1 | Reference(Resource) | Creator,custodian or owner | |||||
code | 0..* | CodeableConcept | Codeable asset context Binding: ContractResourceAssetContextCodes (example): Codes for the context of the asset. | |||||
text | 0..1 | string | Context description | |||||
condition | 0..1 | string | Quality desctiption of asset | |||||
periodType | 0..* | CodeableConcept | Asset availability types Binding: ContractResourceAssetAvailiabilityCodes (example): Codes for asset availability. | |||||
period | 0..* | Period | Time period of the asset | |||||
usePeriod | 0..* | Period | Time period | |||||
text | 0..1 | string | Asset clause or question text | |||||
linkId | 0..* | string | Pointer to asset text | |||||
answer | 0..* | See answer (Contract) | Response to assets | |||||
securityLabelNumber | 0..* | unsignedInt | Asset restriction numbers | |||||
valuedItem | 0..* | BackboneElement | Contract Valued Item List | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
entity[x] | 0..1 | Contract Valued Item Type | ||||||
entityCodeableConcept | CodeableConcept | |||||||
entityReference | Reference(Resource) | |||||||
identifier | 0..1 | Identifier | Contract Valued Item Number | |||||
effectiveTime | 0..1 | dateTime | Contract Valued Item Effective Tiem | |||||
quantity | 0..1 | SimpleQuantity | Count of Contract Valued Items | |||||
unitPrice | 0..1 | Money | Contract Valued Item fee, charge, or cost | |||||
factor | 0..1 | decimal | Contract Valued Item Price Scaling Factor | |||||
points | 0..1 | decimal | Contract Valued Item Difficulty Scaling Factor | |||||
net | 0..1 | Money | Total Contract Valued Item Value | |||||
payment | 0..1 | string | Terms of valuation | |||||
paymentDate | 0..1 | dateTime | When payment is due | |||||
responsible | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who will make payment | |||||
recipient | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who will receive payment | |||||
linkId | 0..* | string | Pointer to specific item | |||||
securityLabelNumber | 0..* | unsignedInt | Security Labels that define affected terms | |||||
action | 0..* | BackboneElement | Entity being ascribed responsibility | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
doNotPerform | ?! | 0..1 | boolean | True if the term prohibits the action | ||||
type | 1..1 | CodeableConcept | Type or form of the action Binding: ContractActionCodes (example): Detailed codes for the contract action. | |||||
subject | 0..* | BackboneElement | Entity of the action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
reference | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | Entity of the action | |||||
role | 0..1 | CodeableConcept | Role type of the agent Binding: ContractActorRoleCodes (example): Detailed codes for the contract actor role. | |||||
intent | 1..1 | CodeableConcept | Purpose for the Contract Term Action Binding: PurposeOfUse (example): Detailed codes for the contract action reason. | |||||
linkId | 0..* | string | Pointer to specific item | |||||
status | 1..1 | CodeableConcept | State of the action Binding: ContractResourceActionStatusCodes (example): Codes for the status of an term action. | |||||
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Episode associated with action | |||||
contextLinkId | 0..* | string | Pointer to specific item | |||||
occurrence[x] | 0..1 | When action happens | ||||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
requester | 0..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | Who asked for action | |||||
requesterLinkId | 0..* | string | Pointer to specific item | |||||
performerType | 0..* | CodeableConcept | Kind of service performer Binding: ProvenanceParticipantType (example): Codes for the types of action perfomer. | |||||
performerRole | 0..1 | CodeableConcept | Competency of the performer Binding: ProvenanceParticipantRole (example): Codes for the role of the action performer. | |||||
performer | 0..1 | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) | Actor that wil execute (or not) the action | |||||
performerLinkId | 0..* | string | Pointer to specific item | |||||
reasonCode | 0..* | CodeableConcept | Why is action (not) needed? Binding: PurposeOfUse (example): Detailed codes for the contract action reason. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) | Why is action (not) needed? | |||||
reason | 0..* | string | Why action is to be performed | |||||
reasonLinkId | 0..* | string | Pointer to specific item | |||||
note | 0..* | Annotation | Comments about the action | |||||
securityLabelNumber | 0..* | unsignedInt | Action restriction numbers | |||||
group | 0..* | See term (Contract) | Nested Contract Term Group | |||||
supportingInfo | 0..* | Reference(Resource) | Extra Information | |||||
relevantHistory | 0..* | Reference(Provenance) | Key event in Contract History | |||||
signer | 0..* | BackboneElement | Contract Signatory | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | Coding | Contract Signatory Role Binding: ContractSignerTypeCodes (preferred): List of parties who may be signing. | |||||
party | 1..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Contract Signatory Party | |||||
signature | 1..* | Signature | Contract Documentation Signature | |||||
friendly | 0..* | BackboneElement | Contract Friendly Language | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
content[x] | 1..1 | Easily comprehended representation of this Contract | ||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | |||||||
legal | 0..* | BackboneElement | Contract Legal Language | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
content[x] | 1..1 | Contract Legal Text | ||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | |||||||
rule | 0..* | BackboneElement | Computable Contract Language | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
content[x] | 1..1 | Computable Contract Rules | ||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(DocumentReference) | |||||||
legallyBinding[x] | 0..1 | Binding Contract | ||||||
legallyBindingAttachment | Attachment | |||||||
legallyBindingReference | Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Contract.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1 from the FHIR Standard | ||||
Contract.legalState | extensible | ContractResourceLegalStateCodeshttp://hl7.org/fhir/ValueSet/contract-legalstate from the FHIR Standard | ||||
Contract.contentDerivative | example | ContractContentDerivationCodeshttp://hl7.org/fhir/ValueSet/contract-content-derivative from the FHIR Standard | ||||
Contract.expirationType | example | ContractResourceExpirationTypeCodeshttp://hl7.org/fhir/ValueSet/contract-expiration-type from the FHIR Standard | ||||
Contract.scope | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-scope from the FHIR Standard | ||||
Contract.type | example | ContractTypeCodeshttp://hl7.org/fhir/ValueSet/contract-type from the FHIR Standard | ||||
Contract.subType | example | ContractSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-subtype from the FHIR Standard | ||||
Contract.contentDefinition.type | example | ContractResourceDefinitionTypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-type from the FHIR Standard | ||||
Contract.contentDefinition.subType | example | ContractResourceDefinitionSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-subtype from the FHIR Standard | ||||
Contract.contentDefinition.publicationStatus | required | ContractResourcePublicationStatusCodeshttp://hl7.org/fhir/ValueSet/contract-publicationstatus|4.0.1 from the FHIR Standard | ||||
Contract.term.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-type from the FHIR Standard | ||||
Contract.term.subType | example | ContractTermSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-subtype from the FHIR Standard | ||||
Contract.term.securityLabel.classification | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-classification from the FHIR Standard | ||||
Contract.term.securityLabel.category | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-category from the FHIR Standard | ||||
Contract.term.securityLabel.control | example | ContractResourceSecurityControlCodeshttp://hl7.org/fhir/ValueSet/contract-security-control from the FHIR Standard | ||||
Contract.term.offer.party.role | example | ContractResourcePartyRoleCodeshttp://hl7.org/fhir/ValueSet/contract-party-role from the FHIR Standard | ||||
Contract.term.offer.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-type from the FHIR Standard | ||||
Contract.term.offer.decision | extensible | ActConsentDirectivehttp://terminology.hl7.org/ValueSet/v3-ActConsentDirective | ||||
Contract.term.offer.decisionMode | example | ContractResourceDecisionModeCodeshttp://hl7.org/fhir/ValueSet/contract-decision-mode from the FHIR Standard | ||||
Contract.term.asset.scope | example | ContractResourceAssetScopeCodeshttp://hl7.org/fhir/ValueSet/contract-assetscope from the FHIR Standard | ||||
Contract.term.asset.type | example | ContractResourceAssetTypeCodeshttp://hl7.org/fhir/ValueSet/contract-assettype from the FHIR Standard | ||||
Contract.term.asset.subtype | example | ContractResourceAssetSub-TypeCodeshttp://hl7.org/fhir/ValueSet/contract-assetsubtype from the FHIR Standard | ||||
Contract.term.asset.relationship | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard | ||||
Contract.term.asset.context.code | example | ContractResourceAssetContextCodeshttp://hl7.org/fhir/ValueSet/contract-assetcontext from the FHIR Standard | ||||
Contract.term.asset.periodType | example | ContractResourceAssetAvailiabilityCodeshttp://hl7.org/fhir/ValueSet/asset-availability from the FHIR Standard | ||||
Contract.term.action.type | example | ContractActionCodeshttp://hl7.org/fhir/ValueSet/contract-action from the FHIR Standard | ||||
Contract.term.action.subject.role | example | ContractActorRoleCodeshttp://hl7.org/fhir/ValueSet/contract-actorrole from the FHIR Standard | ||||
Contract.term.action.intent | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
Contract.term.action.status | example | ContractResourceActionStatusCodeshttp://hl7.org/fhir/ValueSet/contract-actionstatus from the FHIR Standard | ||||
Contract.term.action.performerType | example | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard | ||||
Contract.term.action.performerRole | example | ProvenanceParticipantRolehttp://hl7.org/fhir/ValueSet/provenance-agent-role from the FHIR Standard | ||||
Contract.term.action.reasonCode | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
Contract.signer.type | preferred | ContractSignerTypeCodeshttp://hl7.org/fhir/ValueSet/contract-signer-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Contract | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Contract | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Contract | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Contract
Differential View
This structure is derived from Contract
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Contract | 0..* | Contract | Legal Agreement | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contact | S | 0..1 | (Complex) | SENDIContactExtension URL: http://electronichealth.se/fhir/katalog/StructureDefinition/sendi-contact-extension |
identifier | S | 1..* | Identifier | Contract number |
status | S | 1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated |
applies | S | 1..1 | Period | Effective time |
subject | S | 1..* | Reference(SENDI OrganizationAffiliation) | Contract Target Entity |
type | S | 1..1 | CodeableConcept | Legal instrument category |
subType | S | 1..1 | CodeableConcept | Subtype within the context of type |
term | S | 1..1 | BackboneElement | Contract Term List |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Contract | 0..* | Contract | Legal Agreement | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contact | S | 0..1 | (Complex) | SENDIContactExtension URL: http://electronichealth.se/fhir/katalog/StructureDefinition/sendi-contact-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | Contract number |
status | ?!SΣ | 1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance. |
applies | SΣ | 1..1 | Period | Effective time |
subject | SΣ | 1..* | Reference(SENDI OrganizationAffiliation) | Contract Target Entity |
type | SΣ | 1..1 | CodeableConcept | Legal instrument category Binding: ContractTypeCodes (example): List of overall contract codes. |
subType | SΣ | 1..1 | CodeableConcept | Subtype within the context of type Binding: ContractSubtypeCodes (example): Detailed codes within the above. |
term | S | 1..1 | BackboneElement | Contract Term List |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
offer | 1..1 | BackboneElement | Context of the Contract term | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1 from the FHIR Standard | |
Contract.type | example | ContractTypeCodeshttp://hl7.org/fhir/ValueSet/contract-type from the FHIR Standard | |
Contract.subType | example | ContractSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-subtype from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Contract | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Contract | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Contract | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Contract | 0..* | Contract | Legal Agreement | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
contact | S | 0..1 | (Complex) | SENDIContactExtension URL: http://electronichealth.se/fhir/katalog/StructureDefinition/sendi-contact-extension | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | Contract number | ||||
url | 0..1 | uri | Basal definition | |||||
version | Σ | 0..1 | string | Business edition | ||||
status | ?!SΣ | 1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
legalState | 0..1 | CodeableConcept | Negotiation status Binding: ContractResourceLegalStateCodes (extensible): Detailed codes for the legal state of a contract. | |||||
instantiatesCanonical | 0..1 | Reference(Contract) | Source Contract Definition | |||||
instantiatesUri | 0..1 | uri | External Contract Definition | |||||
contentDerivative | 0..1 | CodeableConcept | Content derived from the basal information Binding: ContractContentDerivationCodes (example): This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source. | |||||
issued | Σ | 0..1 | dateTime | When this Contract was issued | ||||
applies | SΣ | 1..1 | Period | Effective time | ||||
expirationType | 0..1 | CodeableConcept | Contract cessation cause Binding: ContractResourceExpirationTypeCodes (example): Codes for the Cessation of Contracts. | |||||
subject | SΣ | 1..* | Reference(SENDI OrganizationAffiliation) | Contract Target Entity | ||||
authority | 0..* | Reference(Organization) | Authority under which this Contract has standing | |||||
domain | 0..* | Reference(Location) | A sphere of control governed by an authoritative jurisdiction, organization, or person | |||||
site | 0..* | Reference(Location) | Specific Location | |||||
name | Σ | 0..1 | string | Computer friendly designation | ||||
title | Σ | 0..1 | string | Human Friendly name | ||||
subtitle | 0..1 | string | Subordinate Friendly name | |||||
alias | 0..* | string | Acronym or short name | |||||
author | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Organization) | Source of Contract | |||||
scope | 0..1 | CodeableConcept | Range of Legal Concerns Binding: ContractResourceScopeCodes (example): Codes for the range of legal concerns. | |||||
topic[x] | 0..1 | Focus of contract interest | ||||||
topicCodeableConcept | CodeableConcept | |||||||
topicReference | Reference(Resource) | |||||||
type | SΣ | 1..1 | CodeableConcept | Legal instrument category Binding: ContractTypeCodes (example): List of overall contract codes. | ||||
subType | SΣ | 1..1 | CodeableConcept | Subtype within the context of type Binding: ContractSubtypeCodes (example): Detailed codes within the above. | ||||
contentDefinition | 0..1 | BackboneElement | Contract precursor content | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Content structure and use Binding: ContractResourceDefinitionTypeCodes (example): Detailed codes for the definition of contracts. | |||||
subType | 0..1 | CodeableConcept | Detailed Content Type Definition Binding: ContractResourceDefinitionSubtypeCodes (example): Detailed codes for the additional definition of contracts. | |||||
publisher | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Publisher Entity | |||||
publicationDate | 0..1 | dateTime | When published | |||||
publicationStatus | 1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: ContractResourcePublicationStatusCodes (required): Status of the publication of contract content. | |||||
copyright | 0..1 | markdown | Publication Ownership | |||||
term | S | 1..1 | BackboneElement | Contract Term List | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | Σ | 0..1 | Identifier | Contract Term Number | ||||
issued | Σ | 0..1 | dateTime | Contract Term Issue Date Time | ||||
applies | Σ | 0..1 | Period | Contract Term Effective Time | ||||
topic[x] | 0..1 | Term Concern | ||||||
topicCodeableConcept | CodeableConcept | |||||||
topicReference | Reference(Resource) | |||||||
type | 0..1 | CodeableConcept | Contract Term Type or Form Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions. | |||||
subType | 0..1 | CodeableConcept | Contract Term Type specific classification Binding: ContractTermSubtypeCodes (example): Detailed codes for the subtypes of contract provisions. | |||||
text | Σ | 0..1 | string | Term Statement | ||||
securityLabel | 0..* | BackboneElement | Protection for the Term | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
number | 0..* | unsignedInt | Link to Security Labels | |||||
classification | 1..1 | Coding | Confidentiality Protection Binding: ContractResourceScopeCodes (example): Codes for confidentiality protection. | |||||
category | 0..* | Coding | Applicable Policy Binding: ContractResourceScopeCodes (example): Codes for policy category. | |||||
control | 0..* | Coding | Handling Instructions Binding: ContractResourceSecurityControlCodes (example): Codes for handling instructions. | |||||
offer | 1..1 | BackboneElement | Context of the Contract term | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | 0..* | Identifier | Offer business ID | |||||
party | 0..* | BackboneElement | Offer Recipient | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
reference | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | Referenced entity | |||||
role | 1..1 | CodeableConcept | Participant engagement type Binding: ContractResourcePartyRoleCodes (example): Codes for offer participant roles. | |||||
topic | Σ | 0..1 | Reference(Resource) | Negotiable offer asset | ||||
type | 0..1 | CodeableConcept | Contract Offer Type or Form Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions. | |||||
decision | 0..1 | CodeableConcept | Accepting party choice Binding: ActConsentDirective (extensible): The type of decision made by a grantor with respect to an offer made by a grantee. | |||||
decisionMode | 0..* | CodeableConcept | How decision is conveyed Binding: ContractResourceDecisionModeCodes (example): Codes for conveying a decision. | |||||
answer | 0..* | BackboneElement | Response to offer text | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 1..1 | The actual answer response | ||||||
valueBoolean | boolean | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueUri | uri | |||||||
valueAttachment | Attachment | |||||||
valueCoding | Coding | |||||||
valueQuantity | Quantity | |||||||
valueReference | Reference(Resource) | |||||||
text | 0..1 | string | Human readable offer text | |||||
linkId | 0..* | string | Pointer to text | |||||
securityLabelNumber | 0..* | unsignedInt | Offer restriction numbers | |||||
asset | 0..* | BackboneElement | Contract Term Asset List | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
scope | 0..1 | CodeableConcept | Range of asset Binding: ContractResourceAssetScopeCodes (example): Codes for scoping an asset. | |||||
type | 0..* | CodeableConcept | Asset category Binding: ContractResourceAssetTypeCodes (example): Condes for the type of an asset. | |||||
typeReference | 0..* | Reference(Resource) | Associated entities | |||||
subtype | 0..* | CodeableConcept | Asset sub-category Binding: ContractResourceAssetSub-TypeCodes (example): Condes for the sub-type of an asset. | |||||
relationship | 0..1 | Coding | Kinship of the asset Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |||||
context | 0..* | BackboneElement | Circumstance of the asset | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
reference | 0..1 | Reference(Resource) | Creator,custodian or owner | |||||
code | 0..* | CodeableConcept | Codeable asset context Binding: ContractResourceAssetContextCodes (example): Codes for the context of the asset. | |||||
text | 0..1 | string | Context description | |||||
condition | 0..1 | string | Quality desctiption of asset | |||||
periodType | 0..* | CodeableConcept | Asset availability types Binding: ContractResourceAssetAvailiabilityCodes (example): Codes for asset availability. | |||||
period | 0..* | Period | Time period of the asset | |||||
usePeriod | 0..* | Period | Time period | |||||
text | 0..1 | string | Asset clause or question text | |||||
linkId | 0..* | string | Pointer to asset text | |||||
answer | 0..* | See answer (Contract) | Response to assets | |||||
securityLabelNumber | 0..* | unsignedInt | Asset restriction numbers | |||||
valuedItem | 0..* | BackboneElement | Contract Valued Item List | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
entity[x] | 0..1 | Contract Valued Item Type | ||||||
entityCodeableConcept | CodeableConcept | |||||||
entityReference | Reference(Resource) | |||||||
identifier | 0..1 | Identifier | Contract Valued Item Number | |||||
effectiveTime | 0..1 | dateTime | Contract Valued Item Effective Tiem | |||||
quantity | 0..1 | SimpleQuantity | Count of Contract Valued Items | |||||
unitPrice | 0..1 | Money | Contract Valued Item fee, charge, or cost | |||||
factor | 0..1 | decimal | Contract Valued Item Price Scaling Factor | |||||
points | 0..1 | decimal | Contract Valued Item Difficulty Scaling Factor | |||||
net | 0..1 | Money | Total Contract Valued Item Value | |||||
payment | 0..1 | string | Terms of valuation | |||||
paymentDate | 0..1 | dateTime | When payment is due | |||||
responsible | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who will make payment | |||||
recipient | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who will receive payment | |||||
linkId | 0..* | string | Pointer to specific item | |||||
securityLabelNumber | 0..* | unsignedInt | Security Labels that define affected terms | |||||
action | 0..* | BackboneElement | Entity being ascribed responsibility | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
doNotPerform | ?! | 0..1 | boolean | True if the term prohibits the action | ||||
type | 1..1 | CodeableConcept | Type or form of the action Binding: ContractActionCodes (example): Detailed codes for the contract action. | |||||
subject | 0..* | BackboneElement | Entity of the action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
reference | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | Entity of the action | |||||
role | 0..1 | CodeableConcept | Role type of the agent Binding: ContractActorRoleCodes (example): Detailed codes for the contract actor role. | |||||
intent | 1..1 | CodeableConcept | Purpose for the Contract Term Action Binding: PurposeOfUse (example): Detailed codes for the contract action reason. | |||||
linkId | 0..* | string | Pointer to specific item | |||||
status | 1..1 | CodeableConcept | State of the action Binding: ContractResourceActionStatusCodes (example): Codes for the status of an term action. | |||||
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Episode associated with action | |||||
contextLinkId | 0..* | string | Pointer to specific item | |||||
occurrence[x] | 0..1 | When action happens | ||||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
requester | 0..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | Who asked for action | |||||
requesterLinkId | 0..* | string | Pointer to specific item | |||||
performerType | 0..* | CodeableConcept | Kind of service performer Binding: ProvenanceParticipantType (example): Codes for the types of action perfomer. | |||||
performerRole | 0..1 | CodeableConcept | Competency of the performer Binding: ProvenanceParticipantRole (example): Codes for the role of the action performer. | |||||
performer | 0..1 | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) | Actor that wil execute (or not) the action | |||||
performerLinkId | 0..* | string | Pointer to specific item | |||||
reasonCode | 0..* | CodeableConcept | Why is action (not) needed? Binding: PurposeOfUse (example): Detailed codes for the contract action reason. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) | Why is action (not) needed? | |||||
reason | 0..* | string | Why action is to be performed | |||||
reasonLinkId | 0..* | string | Pointer to specific item | |||||
note | 0..* | Annotation | Comments about the action | |||||
securityLabelNumber | 0..* | unsignedInt | Action restriction numbers | |||||
group | 0..* | See term (Contract) | Nested Contract Term Group | |||||
supportingInfo | 0..* | Reference(Resource) | Extra Information | |||||
relevantHistory | 0..* | Reference(Provenance) | Key event in Contract History | |||||
signer | 0..* | BackboneElement | Contract Signatory | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | Coding | Contract Signatory Role Binding: ContractSignerTypeCodes (preferred): List of parties who may be signing. | |||||
party | 1..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Contract Signatory Party | |||||
signature | 1..* | Signature | Contract Documentation Signature | |||||
friendly | 0..* | BackboneElement | Contract Friendly Language | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
content[x] | 1..1 | Easily comprehended representation of this Contract | ||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | |||||||
legal | 0..* | BackboneElement | Contract Legal Language | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
content[x] | 1..1 | Contract Legal Text | ||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | |||||||
rule | 0..* | BackboneElement | Computable Contract Language | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
content[x] | 1..1 | Computable Contract Rules | ||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(DocumentReference) | |||||||
legallyBinding[x] | 0..1 | Binding Contract | ||||||
legallyBindingAttachment | Attachment | |||||||
legallyBindingReference | Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Contract.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1 from the FHIR Standard | ||||
Contract.legalState | extensible | ContractResourceLegalStateCodeshttp://hl7.org/fhir/ValueSet/contract-legalstate from the FHIR Standard | ||||
Contract.contentDerivative | example | ContractContentDerivationCodeshttp://hl7.org/fhir/ValueSet/contract-content-derivative from the FHIR Standard | ||||
Contract.expirationType | example | ContractResourceExpirationTypeCodeshttp://hl7.org/fhir/ValueSet/contract-expiration-type from the FHIR Standard | ||||
Contract.scope | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-scope from the FHIR Standard | ||||
Contract.type | example | ContractTypeCodeshttp://hl7.org/fhir/ValueSet/contract-type from the FHIR Standard | ||||
Contract.subType | example | ContractSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-subtype from the FHIR Standard | ||||
Contract.contentDefinition.type | example | ContractResourceDefinitionTypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-type from the FHIR Standard | ||||
Contract.contentDefinition.subType | example | ContractResourceDefinitionSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-subtype from the FHIR Standard | ||||
Contract.contentDefinition.publicationStatus | required | ContractResourcePublicationStatusCodeshttp://hl7.org/fhir/ValueSet/contract-publicationstatus|4.0.1 from the FHIR Standard | ||||
Contract.term.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-type from the FHIR Standard | ||||
Contract.term.subType | example | ContractTermSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-subtype from the FHIR Standard | ||||
Contract.term.securityLabel.classification | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-classification from the FHIR Standard | ||||
Contract.term.securityLabel.category | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-category from the FHIR Standard | ||||
Contract.term.securityLabel.control | example | ContractResourceSecurityControlCodeshttp://hl7.org/fhir/ValueSet/contract-security-control from the FHIR Standard | ||||
Contract.term.offer.party.role | example | ContractResourcePartyRoleCodeshttp://hl7.org/fhir/ValueSet/contract-party-role from the FHIR Standard | ||||
Contract.term.offer.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-type from the FHIR Standard | ||||
Contract.term.offer.decision | extensible | ActConsentDirectivehttp://terminology.hl7.org/ValueSet/v3-ActConsentDirective | ||||
Contract.term.offer.decisionMode | example | ContractResourceDecisionModeCodeshttp://hl7.org/fhir/ValueSet/contract-decision-mode from the FHIR Standard | ||||
Contract.term.asset.scope | example | ContractResourceAssetScopeCodeshttp://hl7.org/fhir/ValueSet/contract-assetscope from the FHIR Standard | ||||
Contract.term.asset.type | example | ContractResourceAssetTypeCodeshttp://hl7.org/fhir/ValueSet/contract-assettype from the FHIR Standard | ||||
Contract.term.asset.subtype | example | ContractResourceAssetSub-TypeCodeshttp://hl7.org/fhir/ValueSet/contract-assetsubtype from the FHIR Standard | ||||
Contract.term.asset.relationship | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard | ||||
Contract.term.asset.context.code | example | ContractResourceAssetContextCodeshttp://hl7.org/fhir/ValueSet/contract-assetcontext from the FHIR Standard | ||||
Contract.term.asset.periodType | example | ContractResourceAssetAvailiabilityCodeshttp://hl7.org/fhir/ValueSet/asset-availability from the FHIR Standard | ||||
Contract.term.action.type | example | ContractActionCodeshttp://hl7.org/fhir/ValueSet/contract-action from the FHIR Standard | ||||
Contract.term.action.subject.role | example | ContractActorRoleCodeshttp://hl7.org/fhir/ValueSet/contract-actorrole from the FHIR Standard | ||||
Contract.term.action.intent | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
Contract.term.action.status | example | ContractResourceActionStatusCodeshttp://hl7.org/fhir/ValueSet/contract-actionstatus from the FHIR Standard | ||||
Contract.term.action.performerType | example | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard | ||||
Contract.term.action.performerRole | example | ProvenanceParticipantRolehttp://hl7.org/fhir/ValueSet/provenance-agent-role from the FHIR Standard | ||||
Contract.term.action.reasonCode | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
Contract.signer.type | preferred | ContractSignerTypeCodeshttp://hl7.org/fhir/ValueSet/contract-signer-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Contract | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Contract | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Contract | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Contract | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Contract
Other representations of profile: CSV, Excel, Schematron