MedNet interface implementation guide
0.16.0 - CI Build

Publication Build: This will be filled in by the publication tooling

Resource Profile: MedNet Interface (MNI) - Contract

Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-contract Version: 0.16.0
Active as of 2020-11-06 Computable Name: MNIContract

Copyright/Legal: novcom AG

MedNet Interface (MNI) - Contract Profile

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..* Contract MedNet Interface (MNI) - Contract
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 0..1 uri the system that delivers the contract id. It must be an uri like http://www.mycompany.com
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 0..1 code amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance.

... type SΣ 0..1 CodeableConcept Legal instrument category
Binding: ContractTypeCodes (example): List of overall contract codes.

.... coding SΣ 0..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Recommended value http://terminology.hl7.org/CodeSystem/contract-type
..... code SΣ 1..1 code privacy (Privacy) | disclosure (Disclosure) | healthinsurance (Health Insurance) | supply (Supply Contract) | consent (Consent)
..... display SΣ 0..1 string Representation defined by the system

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Contract.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Contract.statusrequiredContractResourceStatusCodes
http://hl7.org/fhir/ValueSet/contract-status|4.0.1
from the FHIR Standard
Contract.typeexampleContractTypeCodes
http://hl7.org/fhir/ValueSet/contract-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorContractIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorContractIf 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-4errorContractIf 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-5errorContractIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceContractA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..* Contract MedNet Interface (MNI) - Contract
... id S 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... identifier S 0..* Identifier Contract number
.... system S 0..1 uri the system that delivers the contract id. It must be an uri like http://www.mycompany.com
.... value S 1..1 string The value that is unique
... type S 0..1 CodeableConcept Legal instrument category
.... coding S 0..* Coding Code defined by a terminology system
..... system S 1..1 uri Recommended value http://terminology.hl7.org/CodeSystem/contract-type
..... code S 1..1 code privacy (Privacy) | disclosure (Disclosure) | healthinsurance (Health Insurance) | supply (Supply Contract) | consent (Consent)
..... display S 0..1 string Representation defined by the system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..* Contract MedNet Interface (MNI) - Contract
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Contract number
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri the system that delivers the contract id. It must be an uri like http://www.mycompany.com
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... url 0..1 uri Basal definition
... version Σ 0..1 string Business edition
... status ?!Σ 0..1 code amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance.

... legalState 0..1 CodeableConcept Negotiation status
Binding: ContractResourceLegalStateCodes (extensible): Detailed codes for the legal state of a contract.

... instantiatesCanonical 0..1 Reference(Contract) Source Contract Definition
... instantiatesUri 0..1 uri External Contract Definition
... contentDerivative 0..1 CodeableConcept Content derived from the basal information
Binding: ContractContentDerivationCodes (example): This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source.

... issued Σ 0..1 dateTime When this Contract was issued
... applies Σ 0..1 Period Effective time
... expirationType 0..1 CodeableConcept Contract cessation cause
Binding: ContractResourceExpirationTypeCodes (example): Codes for the Cessation of Contracts.

... subject Σ 0..* Reference(Resource) Contract Target Entity
... authority 0..* Reference(Organization) Authority under which this Contract has standing
... domain 0..* Reference(Location) A sphere of control governed by an authoritative jurisdiction, organization, or person
... site 0..* Reference(Location) Specific Location
... name Σ 0..1 string Computer friendly designation
... title Σ 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Σ 0..1 CodeableConcept Legal instrument category
Binding: ContractTypeCodes (example): List of overall contract codes.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Recommended value http://terminology.hl7.org/CodeSystem/contract-type
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code privacy (Privacy) | disclosure (Disclosure) | healthinsurance (Health Insurance) | supply (Supply Contract) | consent (Consent)
..... display SΣ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subType Σ 0..* CodeableConcept Subtype within the context of type
Binding: ContractSubtypeCodes (example): Detailed codes within the above.


... contentDefinition 0..1 BackboneElement Contract precursor content
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Content structure and use
Binding: ContractResourceDefinitionTypeCodes (example): Detailed codes for the definition of contracts.

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

.... publisher 0..1 Reference(Practitioner | PractitionerRole | Organization) Publisher Entity
.... publicationDate 0..1 dateTime When published
.... publicationStatus 1..1 code amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Binding: ContractResourcePublicationStatusCodes (required): Status of the publication of contract content.

.... copyright 0..1 markdown Publication Ownership
... term 0..* BackboneElement Contract Term List
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..1 Identifier Contract Term Number
.... issued Σ 0..1 dateTime Contract Term Issue Date Time
.... applies Σ 0..1 Period Contract Term Effective Time
.... topic[x] 0..1 Term Concern
..... topicCodeableConcept CodeableConcept
..... topicReference Reference(Resource)
.... type 0..1 CodeableConcept Contract Term Type or Form
Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions.

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

.... text Σ 0..1 string Term Statement
.... securityLabel 0..* BackboneElement Protection for the Term
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... number 0..* unsignedInt Link to Security Labels
..... classification 1..1 Coding Confidentiality Protection
Binding: ContractResourceScopeCodes (example): Codes for confidentiality protection.

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


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


.... offer 1..1 BackboneElement Context of the Contract term
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... identifier 0..* Identifier Offer business ID
..... party 0..* BackboneElement Offer Recipient
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... reference 1..* Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) Referenced entity
...... role 1..1 CodeableConcept Participant engagement type
Binding: ContractResourcePartyRoleCodes (example): Codes for offer participant roles.

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

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

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


..... answer 0..* BackboneElement Response to offer text
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... value[x] 1..1 The actual answer response
....... valueBoolean boolean
....... valueDecimal decimal
....... valueInteger integer
....... valueDate date
....... valueDateTime dateTime
....... valueTime time
....... valueString string
....... valueUri uri
....... valueAttachment Attachment
....... valueCoding Coding
....... valueQuantity Quantity
....... valueReference Reference(Resource)
..... text 0..1 string Human readable offer text
..... linkId 0..* string Pointer to text
..... securityLabelNumber 0..* unsignedInt Offer restriction numbers
.... asset 0..* BackboneElement Contract Term Asset List
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... scope 0..1 CodeableConcept Range of asset
Binding: ContractResourceAssetScopeCodes (example): Codes for scoping an asset.

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


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


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

..... context 0..* BackboneElement Circumstance of the asset
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... reference 0..1 Reference(Resource) Creator,custodian or owner
...... code 0..* CodeableConcept Codeable asset context
Binding: ContractResourceAssetContextCodes (example): Codes for the context of the asset.


...... text 0..1 string Context description
..... condition 0..1 string Quality desctiption of asset
..... periodType 0..* CodeableConcept Asset availability types
Binding: ContractResourceAssetAvailiabilityCodes (example): Codes for asset availability.


..... period 0..* Period Time period of the asset
..... usePeriod 0..* Period Time period
..... text 0..1 string Asset clause or question text
..... linkId 0..* string Pointer to asset text
..... answer 0..* See answer (Contract) Response to assets
..... securityLabelNumber 0..* unsignedInt Asset restriction numbers
..... valuedItem 0..* BackboneElement Contract Valued Item List
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... entity[x] 0..1 Contract Valued Item Type
....... entityCodeableConcept CodeableConcept
....... entityReference Reference(Resource)
...... identifier 0..1 Identifier Contract Valued Item Number
...... effectiveTime 0..1 dateTime Contract Valued Item Effective Tiem
...... quantity 0..1 SimpleQuantity Count of Contract Valued Items
...... unitPrice 0..1 Money Contract Valued Item fee, charge, or cost
...... factor 0..1 decimal Contract Valued Item Price Scaling Factor
...... points 0..1 decimal Contract Valued Item Difficulty Scaling Factor
...... net 0..1 Money Total Contract Valued Item Value
...... payment 0..1 string Terms of valuation
...... paymentDate 0..1 dateTime When payment is due
...... responsible 0..1 Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who will make payment
...... recipient 0..1 Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who will receive payment
...... linkId 0..* string Pointer to specific item
...... securityLabelNumber 0..* unsignedInt Security Labels that define affected terms
.... action 0..* BackboneElement Entity being ascribed responsibility
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... doNotPerform ?! 0..1 boolean True if the term prohibits the action
..... type 1..1 CodeableConcept Type or form of the action
Binding: ContractActionCodes (example): Detailed codes for the contract action.

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

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

..... linkId 0..* string Pointer to specific item
..... status 1..1 CodeableConcept State of the action
Binding: ContractResourceActionStatusCodes (example): Codes for the status of an term action.

..... context 0..1 Reference(Encounter | EpisodeOfCare) Episode associated with action
..... contextLinkId 0..* string Pointer to specific item
..... occurrence[x] 0..1 When action happens
...... occurrenceDateTime dateTime
...... occurrencePeriod Period
...... occurrenceTiming Timing
..... requester 0..* Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) Who asked for action
..... requesterLinkId 0..* string Pointer to specific item
..... performerType 0..* CodeableConcept Kind of service performer
Binding: ProvenanceParticipantType (example): Codes for the types of action perfomer.


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

..... performer 0..1 Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) Actor that wil execute (or not) the action
..... performerLinkId 0..* string Pointer to specific item
..... reasonCode 0..* CodeableConcept Why is action (not) needed?
Binding: PurposeOfUse (example): Detailed codes for the contract action reason.


..... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) Why is action (not) needed?
..... reason 0..* string Why action is to be performed
..... reasonLinkId 0..* string Pointer to specific item
..... note 0..* Annotation Comments about the action
..... securityLabelNumber 0..* unsignedInt Action restriction numbers
.... group 0..* See term (Contract) Nested Contract Term Group
... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Contract.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Contract.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Contract.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Contract.statusrequiredContractResourceStatusCodes
http://hl7.org/fhir/ValueSet/contract-status|4.0.1
from the FHIR Standard
Contract.legalStateextensibleContractResourceLegalStateCodes
http://hl7.org/fhir/ValueSet/contract-legalstate
from the FHIR Standard
Contract.contentDerivativeexampleContractContentDerivationCodes
http://hl7.org/fhir/ValueSet/contract-content-derivative
from the FHIR Standard
Contract.expirationTypeexampleContractResourceExpirationTypeCodes
http://hl7.org/fhir/ValueSet/contract-expiration-type
from the FHIR Standard
Contract.scopeexampleContractResourceScopeCodes
http://hl7.org/fhir/ValueSet/contract-scope
from the FHIR Standard
Contract.typeexampleContractTypeCodes
http://hl7.org/fhir/ValueSet/contract-type
from the FHIR Standard
Contract.subTypeexampleContractSubtypeCodes
http://hl7.org/fhir/ValueSet/contract-subtype
from the FHIR Standard
Contract.contentDefinition.typeexampleContractResourceDefinitionTypeCodes
http://hl7.org/fhir/ValueSet/contract-definition-type
from the FHIR Standard
Contract.contentDefinition.subTypeexampleContractResourceDefinitionSubtypeCodes
http://hl7.org/fhir/ValueSet/contract-definition-subtype
from the FHIR Standard
Contract.contentDefinition.publicationStatusrequiredContractResourcePublicationStatusCodes
http://hl7.org/fhir/ValueSet/contract-publicationstatus|4.0.1
from the FHIR Standard
Contract.term.typeexampleContractTermTypeCodes
http://hl7.org/fhir/ValueSet/contract-term-type
from the FHIR Standard
Contract.term.subTypeexampleContractTermSubtypeCodes
http://hl7.org/fhir/ValueSet/contract-term-subtype
from the FHIR Standard
Contract.term.securityLabel.classificationexampleContractResourceScopeCodes
http://hl7.org/fhir/ValueSet/contract-security-classification
from the FHIR Standard
Contract.term.securityLabel.categoryexampleContractResourceScopeCodes
http://hl7.org/fhir/ValueSet/contract-security-category
from the FHIR Standard
Contract.term.securityLabel.controlexampleContractResourceSecurityControlCodes
http://hl7.org/fhir/ValueSet/contract-security-control
from the FHIR Standard
Contract.term.offer.party.roleexampleContractResourcePartyRoleCodes
http://hl7.org/fhir/ValueSet/contract-party-role
from the FHIR Standard
Contract.term.offer.typeexampleContractTermTypeCodes
http://hl7.org/fhir/ValueSet/contract-term-type
from the FHIR Standard
Contract.term.offer.decisionextensibleActConsentDirective
http://terminology.hl7.org/ValueSet/v3-ActConsentDirective
Contract.term.offer.decisionModeexampleContractResourceDecisionModeCodes
http://hl7.org/fhir/ValueSet/contract-decision-mode
from the FHIR Standard
Contract.term.asset.scopeexampleContractResourceAssetScopeCodes
http://hl7.org/fhir/ValueSet/contract-assetscope
from the FHIR Standard
Contract.term.asset.typeexampleContractResourceAssetTypeCodes
http://hl7.org/fhir/ValueSet/contract-assettype
from the FHIR Standard
Contract.term.asset.subtypeexampleContractResourceAssetSub-TypeCodes
http://hl7.org/fhir/ValueSet/contract-assetsubtype
from the FHIR Standard
Contract.term.asset.relationshipextensibleConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
from the FHIR Standard
Contract.term.asset.context.codeexampleContractResourceAssetContextCodes
http://hl7.org/fhir/ValueSet/contract-assetcontext
from the FHIR Standard
Contract.term.asset.periodTypeexampleContractResourceAssetAvailiabilityCodes
http://hl7.org/fhir/ValueSet/asset-availability
from the FHIR Standard
Contract.term.action.typeexampleContractActionCodes
http://hl7.org/fhir/ValueSet/contract-action
from the FHIR Standard
Contract.term.action.subject.roleexampleContractActorRoleCodes
http://hl7.org/fhir/ValueSet/contract-actorrole
from the FHIR Standard
Contract.term.action.intentexamplePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Contract.term.action.statusexampleContractResourceActionStatusCodes
http://hl7.org/fhir/ValueSet/contract-actionstatus
from the FHIR Standard
Contract.term.action.performerTypeexampleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Contract.term.action.performerRoleexampleProvenanceParticipantRole
http://hl7.org/fhir/ValueSet/provenance-agent-role
from the FHIR Standard
Contract.term.action.reasonCodeexamplePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Contract.signer.typepreferredContractSignerTypeCodes
http://hl7.org/fhir/ValueSet/contract-signer-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorContractIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorContractIf 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-4errorContractIf 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-5errorContractIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceContractA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Contract

Summary

Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 9 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..* Contract MedNet Interface (MNI) - Contract
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 0..1 uri the system that delivers the contract id. It must be an uri like http://www.mycompany.com
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 0..1 code amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance.

... type SΣ 0..1 CodeableConcept Legal instrument category
Binding: ContractTypeCodes (example): List of overall contract codes.

.... coding SΣ 0..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Recommended value http://terminology.hl7.org/CodeSystem/contract-type
..... code SΣ 1..1 code privacy (Privacy) | disclosure (Disclosure) | healthinsurance (Health Insurance) | supply (Supply Contract) | consent (Consent)
..... display SΣ 0..1 string Representation defined by the system

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Contract.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Contract.statusrequiredContractResourceStatusCodes
http://hl7.org/fhir/ValueSet/contract-status|4.0.1
from the FHIR Standard
Contract.typeexampleContractTypeCodes
http://hl7.org/fhir/ValueSet/contract-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorContractIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorContractIf 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-4errorContractIf 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-5errorContractIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceContractA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..* Contract MedNet Interface (MNI) - Contract
... id S 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... identifier S 0..* Identifier Contract number
.... system S 0..1 uri the system that delivers the contract id. It must be an uri like http://www.mycompany.com
.... value S 1..1 string The value that is unique
... type S 0..1 CodeableConcept Legal instrument category
.... coding S 0..* Coding Code defined by a terminology system
..... system S 1..1 uri Recommended value http://terminology.hl7.org/CodeSystem/contract-type
..... code S 1..1 code privacy (Privacy) | disclosure (Disclosure) | healthinsurance (Health Insurance) | supply (Supply Contract) | consent (Consent)
..... display S 0..1 string Representation defined by the system

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..* Contract MedNet Interface (MNI) - Contract
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Contract number
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri the system that delivers the contract id. It must be an uri like http://www.mycompany.com
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... url 0..1 uri Basal definition
... version Σ 0..1 string Business edition
... status ?!Σ 0..1 code amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Binding: ContractResourceStatusCodes (required): A code specifying the state of the resource instance.

... legalState 0..1 CodeableConcept Negotiation status
Binding: ContractResourceLegalStateCodes (extensible): Detailed codes for the legal state of a contract.

... instantiatesCanonical 0..1 Reference(Contract) Source Contract Definition
... instantiatesUri 0..1 uri External Contract Definition
... contentDerivative 0..1 CodeableConcept Content derived from the basal information
Binding: ContractContentDerivationCodes (example): This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source.

... issued Σ 0..1 dateTime When this Contract was issued
... applies Σ 0..1 Period Effective time
... expirationType 0..1 CodeableConcept Contract cessation cause
Binding: ContractResourceExpirationTypeCodes (example): Codes for the Cessation of Contracts.

... subject Σ 0..* Reference(Resource) Contract Target Entity
... authority 0..* Reference(Organization) Authority under which this Contract has standing
... domain 0..* Reference(Location) A sphere of control governed by an authoritative jurisdiction, organization, or person
... site 0..* Reference(Location) Specific Location
... name Σ 0..1 string Computer friendly designation
... title Σ 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Σ 0..1 CodeableConcept Legal instrument category
Binding: ContractTypeCodes (example): List of overall contract codes.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Recommended value http://terminology.hl7.org/CodeSystem/contract-type
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code privacy (Privacy) | disclosure (Disclosure) | healthinsurance (Health Insurance) | supply (Supply Contract) | consent (Consent)
..... display SΣ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subType Σ 0..* CodeableConcept Subtype within the context of type
Binding: ContractSubtypeCodes (example): Detailed codes within the above.


... contentDefinition 0..1 BackboneElement Contract precursor content
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Content structure and use
Binding: ContractResourceDefinitionTypeCodes (example): Detailed codes for the definition of contracts.

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

.... publisher 0..1 Reference(Practitioner | PractitionerRole | Organization) Publisher Entity
.... publicationDate 0..1 dateTime When published
.... publicationStatus 1..1 code amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Binding: ContractResourcePublicationStatusCodes (required): Status of the publication of contract content.

.... copyright 0..1 markdown Publication Ownership
... term 0..* BackboneElement Contract Term List
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..1 Identifier Contract Term Number
.... issued Σ 0..1 dateTime Contract Term Issue Date Time
.... applies Σ 0..1 Period Contract Term Effective Time
.... topic[x] 0..1 Term Concern
..... topicCodeableConcept CodeableConcept
..... topicReference Reference(Resource)
.... type 0..1 CodeableConcept Contract Term Type or Form
Binding: ContractTermTypeCodes (example): Detailed codes for the types of contract provisions.

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

.... text Σ 0..1 string Term Statement
.... securityLabel 0..* BackboneElement Protection for the Term
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... number 0..* unsignedInt Link to Security Labels
..... classification 1..1 Coding Confidentiality Protection
Binding: ContractResourceScopeCodes (example): Codes for confidentiality protection.

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


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


.... offer 1..1 BackboneElement Context of the Contract term
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... identifier 0..* Identifier Offer business ID
..... party 0..* BackboneElement Offer Recipient
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... reference 1..* Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) Referenced entity
...... role 1..1 CodeableConcept Participant engagement type
Binding: ContractResourcePartyRoleCodes (example): Codes for offer participant roles.

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

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

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


..... answer 0..* BackboneElement Response to offer text
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... value[x] 1..1 The actual answer response
....... valueBoolean boolean
....... valueDecimal decimal
....... valueInteger integer
....... valueDate date
....... valueDateTime dateTime
....... valueTime time
....... valueString string
....... valueUri uri
....... valueAttachment Attachment
....... valueCoding Coding
....... valueQuantity Quantity
....... valueReference Reference(Resource)
..... text 0..1 string Human readable offer text
..... linkId 0..* string Pointer to text
..... securityLabelNumber 0..* unsignedInt Offer restriction numbers
.... asset 0..* BackboneElement Contract Term Asset List
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... scope 0..1 CodeableConcept Range of asset
Binding: ContractResourceAssetScopeCodes (example): Codes for scoping an asset.

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


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


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

..... context 0..* BackboneElement Circumstance of the asset
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... reference 0..1 Reference(Resource) Creator,custodian or owner
...... code 0..* CodeableConcept Codeable asset context
Binding: ContractResourceAssetContextCodes (example): Codes for the context of the asset.


...... text 0..1 string Context description
..... condition 0..1 string Quality desctiption of asset
..... periodType 0..* CodeableConcept Asset availability types
Binding: ContractResourceAssetAvailiabilityCodes (example): Codes for asset availability.


..... period 0..* Period Time period of the asset
..... usePeriod 0..* Period Time period
..... text 0..1 string Asset clause or question text
..... linkId 0..* string Pointer to asset text
..... answer 0..* See answer (Contract) Response to assets
..... securityLabelNumber 0..* unsignedInt Asset restriction numbers
..... valuedItem 0..* BackboneElement Contract Valued Item List
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... entity[x] 0..1 Contract Valued Item Type
....... entityCodeableConcept CodeableConcept
....... entityReference Reference(Resource)
...... identifier 0..1 Identifier Contract Valued Item Number
...... effectiveTime 0..1 dateTime Contract Valued Item Effective Tiem
...... quantity 0..1 SimpleQuantity Count of Contract Valued Items
...... unitPrice 0..1 Money Contract Valued Item fee, charge, or cost
...... factor 0..1 decimal Contract Valued Item Price Scaling Factor
...... points 0..1 decimal Contract Valued Item Difficulty Scaling Factor
...... net 0..1 Money Total Contract Valued Item Value
...... payment 0..1 string Terms of valuation
...... paymentDate 0..1 dateTime When payment is due
...... responsible 0..1 Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who will make payment
...... recipient 0..1 Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who will receive payment
...... linkId 0..* string Pointer to specific item
...... securityLabelNumber 0..* unsignedInt Security Labels that define affected terms
.... action 0..* BackboneElement Entity being ascribed responsibility
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... doNotPerform ?! 0..1 boolean True if the term prohibits the action
..... type 1..1 CodeableConcept Type or form of the action
Binding: ContractActionCodes (example): Detailed codes for the contract action.

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

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

..... linkId 0..* string Pointer to specific item
..... status 1..1 CodeableConcept State of the action
Binding: ContractResourceActionStatusCodes (example): Codes for the status of an term action.

..... context 0..1 Reference(Encounter | EpisodeOfCare) Episode associated with action
..... contextLinkId 0..* string Pointer to specific item
..... occurrence[x] 0..1 When action happens
...... occurrenceDateTime dateTime
...... occurrencePeriod Period
...... occurrenceTiming Timing
..... requester 0..* Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) Who asked for action
..... requesterLinkId 0..* string Pointer to specific item
..... performerType 0..* CodeableConcept Kind of service performer
Binding: ProvenanceParticipantType (example): Codes for the types of action perfomer.


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

..... performer 0..1 Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) Actor that wil execute (or not) the action
..... performerLinkId 0..* string Pointer to specific item
..... reasonCode 0..* CodeableConcept Why is action (not) needed?
Binding: PurposeOfUse (example): Detailed codes for the contract action reason.


..... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) Why is action (not) needed?
..... reason 0..* string Why action is to be performed
..... reasonLinkId 0..* string Pointer to specific item
..... note 0..* Annotation Comments about the action
..... securityLabelNumber 0..* unsignedInt Action restriction numbers
.... group 0..* See term (Contract) Nested Contract Term Group
... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Contract.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Contract.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Contract.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Contract.statusrequiredContractResourceStatusCodes
http://hl7.org/fhir/ValueSet/contract-status|4.0.1
from the FHIR Standard
Contract.legalStateextensibleContractResourceLegalStateCodes
http://hl7.org/fhir/ValueSet/contract-legalstate
from the FHIR Standard
Contract.contentDerivativeexampleContractContentDerivationCodes
http://hl7.org/fhir/ValueSet/contract-content-derivative
from the FHIR Standard
Contract.expirationTypeexampleContractResourceExpirationTypeCodes
http://hl7.org/fhir/ValueSet/contract-expiration-type
from the FHIR Standard
Contract.scopeexampleContractResourceScopeCodes
http://hl7.org/fhir/ValueSet/contract-scope
from the FHIR Standard
Contract.typeexampleContractTypeCodes
http://hl7.org/fhir/ValueSet/contract-type
from the FHIR Standard
Contract.subTypeexampleContractSubtypeCodes
http://hl7.org/fhir/ValueSet/contract-subtype
from the FHIR Standard
Contract.contentDefinition.typeexampleContractResourceDefinitionTypeCodes
http://hl7.org/fhir/ValueSet/contract-definition-type
from the FHIR Standard
Contract.contentDefinition.subTypeexampleContractResourceDefinitionSubtypeCodes
http://hl7.org/fhir/ValueSet/contract-definition-subtype
from the FHIR Standard
Contract.contentDefinition.publicationStatusrequiredContractResourcePublicationStatusCodes
http://hl7.org/fhir/ValueSet/contract-publicationstatus|4.0.1
from the FHIR Standard
Contract.term.typeexampleContractTermTypeCodes
http://hl7.org/fhir/ValueSet/contract-term-type
from the FHIR Standard
Contract.term.subTypeexampleContractTermSubtypeCodes
http://hl7.org/fhir/ValueSet/contract-term-subtype
from the FHIR Standard
Contract.term.securityLabel.classificationexampleContractResourceScopeCodes
http://hl7.org/fhir/ValueSet/contract-security-classification
from the FHIR Standard
Contract.term.securityLabel.categoryexampleContractResourceScopeCodes
http://hl7.org/fhir/ValueSet/contract-security-category
from the FHIR Standard
Contract.term.securityLabel.controlexampleContractResourceSecurityControlCodes
http://hl7.org/fhir/ValueSet/contract-security-control
from the FHIR Standard
Contract.term.offer.party.roleexampleContractResourcePartyRoleCodes
http://hl7.org/fhir/ValueSet/contract-party-role
from the FHIR Standard
Contract.term.offer.typeexampleContractTermTypeCodes
http://hl7.org/fhir/ValueSet/contract-term-type
from the FHIR Standard
Contract.term.offer.decisionextensibleActConsentDirective
http://terminology.hl7.org/ValueSet/v3-ActConsentDirective
Contract.term.offer.decisionModeexampleContractResourceDecisionModeCodes
http://hl7.org/fhir/ValueSet/contract-decision-mode
from the FHIR Standard
Contract.term.asset.scopeexampleContractResourceAssetScopeCodes
http://hl7.org/fhir/ValueSet/contract-assetscope
from the FHIR Standard
Contract.term.asset.typeexampleContractResourceAssetTypeCodes
http://hl7.org/fhir/ValueSet/contract-assettype
from the FHIR Standard
Contract.term.asset.subtypeexampleContractResourceAssetSub-TypeCodes
http://hl7.org/fhir/ValueSet/contract-assetsubtype
from the FHIR Standard
Contract.term.asset.relationshipextensibleConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
from the FHIR Standard
Contract.term.asset.context.codeexampleContractResourceAssetContextCodes
http://hl7.org/fhir/ValueSet/contract-assetcontext
from the FHIR Standard
Contract.term.asset.periodTypeexampleContractResourceAssetAvailiabilityCodes
http://hl7.org/fhir/ValueSet/asset-availability
from the FHIR Standard
Contract.term.action.typeexampleContractActionCodes
http://hl7.org/fhir/ValueSet/contract-action
from the FHIR Standard
Contract.term.action.subject.roleexampleContractActorRoleCodes
http://hl7.org/fhir/ValueSet/contract-actorrole
from the FHIR Standard
Contract.term.action.intentexamplePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Contract.term.action.statusexampleContractResourceActionStatusCodes
http://hl7.org/fhir/ValueSet/contract-actionstatus
from the FHIR Standard
Contract.term.action.performerTypeexampleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Contract.term.action.performerRoleexampleProvenanceParticipantRole
http://hl7.org/fhir/ValueSet/provenance-agent-role
from the FHIR Standard
Contract.term.action.reasonCodeexamplePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Contract.signer.typepreferredContractSignerTypeCodes
http://hl7.org/fhir/ValueSet/contract-signer-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorContractIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorContractIf 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-4errorContractIf 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-5errorContractIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceContractA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Contract

Summary

Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 9 elements

 

Other representations of profile: CSV, Excel, Schematron