Contract

ResourceFinancial · GeneralTrial useMaturity 1

Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

10 of 10 parameters tested

Structure

Show inherited elements (53)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Contract number
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 | terminatedBinding (required): contract-status
legalState	0..1	CodeableConcept	Negotiation statusBinding (extensible): contract-legalstate
instantiatesCanonical	0..1	Reference(Contract)	Source Contract Definition
instantiatesUri	0..1	uri	External Contract Definition
contentDerivative	0..1	CodeableConcept	Content derived from the basal informationBinding (example): contract-content-derivative
issuedΣ	0..1	dateTime	When this Contract was issued
appliesΣ	0..1	Period	Effective time
expirationType	0..1	CodeableConcept	Contract cessation causeBinding (example): contract-expiration-type
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 ConcernsBinding (example): contract-scope
topic[x]	0..1	CodeableConcept | Reference(Resource)	Focus of contract interest
typeΣ	0..1	CodeableConcept	Legal instrument categoryBinding (example): contract-type
subTypeΣ	0..*	CodeableConcept	Subtype within the context of typeBinding (example): contract-subtype
contentDefinition	0..1	BackboneElement	Contract precursor content
typeRequired	1..1	CodeableConcept	Content structure and useBinding (example): contract-definition-type
subType	0..1	CodeableConcept	Detailed Content Type DefinitionBinding (example): contract-definition-subtype
publisher	0..1	Reference(Practitioner | PractitionerRole | Organization)	Publisher Entity
publicationDate	0..1	dateTime	When published
publicationStatusRequired	1..1	code	amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminatedBinding (required): contract-publicationstatus
copyright	0..1	markdown	Publication Ownership
term	0..*	BackboneElement	Contract Term List
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	CodeableConcept | Reference(Resource)	Term Concern
type	0..1	CodeableConcept	Contract Term Type or FormBinding (example): contract-term-type
subType	0..1	CodeableConcept	Contract Term Type specific classificationBinding (example): contract-term-subtype
textΣ	0..1	string	Term Statement
securityLabel	0..*	BackboneElement	Protection for the Term
number	0..*	unsignedInt	Link to Security Labels
classificationRequired	1..1	Coding	Confidentiality ProtectionBinding (example): contract-security-classification
category	0..*	Coding	Applicable PolicyBinding (example): contract-security-category
control	0..*	Coding	Handling InstructionsBinding (example): contract-security-control
offerRequired	1..1	BackboneElement	Context of the Contract term
identifier	0..*	Identifier	Offer business ID
party	0..*	BackboneElement	Offer Recipient
referenceRequired	1..*	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization)	Referenced entity
roleRequired	1..1	CodeableConcept	Participant engagement typeBinding (example): contract-party-role
topicΣ	0..1	Reference(Resource)	Negotiable offer asset
type	0..1	CodeableConcept	Contract Offer Type or FormBinding (example): contract-term-type
decision	0..1	CodeableConcept	Accepting party choiceBinding (extensible): v3-ActConsentDirective
decisionMode	0..*	CodeableConcept	How decision is conveyedBinding (example): contract-decision-mode
answer	0..*	BackboneElement	Response to offer text
value[x]Required	1..1	boolean | decimal | integer | date | dateTime | time | string | uri | Attachment | Coding | Quantity | Reference(Resource)	The actual answer response
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
scope	0..1	CodeableConcept	Range of assetBinding (example): contract-assetscope
type	0..*	CodeableConcept	Asset categoryBinding (example): contract-assettype
typeReference	0..*	Reference(Resource)	Associated entities
subtype	0..*	CodeableConcept	Asset sub-categoryBinding (example): contract-assetsubtype
relationship	0..1	Coding	Kinship of the assetBinding (extensible): consent-content-class
context	0..*	BackboneElement	Circumstance of the asset
reference	0..1	Reference(Resource)	Creator,custodian or owner
code	0..*	CodeableConcept	Codeable asset contextBinding (example): contract-assetcontext
text	0..1	string	Context description
condition	0..1	string	Quality desctiption of asset
periodType	0..*	CodeableConcept	Asset availability typesBinding (example): 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..*	Same as Contract.term.offer.answer	Response to assets
securityLabelNumber	0..*	unsignedInt	Asset restriction numbers
valuedItem	0..*	BackboneElement	Contract Valued Item List
entity[x]	0..1	CodeableConcept | Reference(Resource)	Contract Valued Item Type
identifier	0..1	Identifier	Contract Valued Item Number
effectiveTime	0..1	dateTime	Contract Valued Item Effective Tiem
quantity	0..1	Quantity	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
doNotPerform?!	0..1	boolean	True if the term prohibits the action
typeRequired	1..1	CodeableConcept	Type or form of the actionBinding (example): contract-action
subject	0..*	BackboneElement	Entity of the action
referenceRequired	1..*	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization)	Entity of the action
role	0..1	CodeableConcept	Role type of the agentBinding (example): contract-actorrole
intentRequired	1..1	CodeableConcept	Purpose for the Contract Term ActionBinding (example): v3-PurposeOfUse
linkId	0..*	string	Pointer to specific item
statusRequired	1..1	CodeableConcept	State of the actionBinding (example): contract-actionstatus
context	0..1	Reference(Encounter | EpisodeOfCare)	Episode associated with action
contextLinkId	0..*	string	Pointer to specific item
occurrence[x]	0..1	dateTime | Period | Timing	When action happens
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 performerBinding (example): provenance-agent-type
performerRole	0..1	CodeableConcept	Competency of the performerBinding (example): provenance-agent-role
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 (example): v3-PurposeOfUse
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..*	Same as Contract.term	Nested Contract Term Group
supportingInfo	0..*	Reference(Resource)	Extra Information
relevantHistory	0..*	Reference(Provenance)	Key event in Contract History
signer	0..*	BackboneElement	Contract Signatory
typeRequired	1..1	Coding	Contract Signatory RoleBinding (preferred): contract-signer-type
partyRequired	1..1	Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)	Contract Signatory Party
signatureRequired	1..*	Signature	Contract Documentation Signature
friendly	0..*	BackboneElement	Contract Friendly Language
content[x]Required	1..1	Attachment | Reference(Composition | DocumentReference | QuestionnaireResponse)	Easily comprehended representation of this Contract
legal	0..*	BackboneElement	Contract Legal Language
content[x]Required	1..1	Attachment | Reference(Composition | DocumentReference | QuestionnaireResponse)	Contract Legal Text
rule	0..*	BackboneElement	Computable Contract Language
content[x]Required	1..1	Attachment | Reference(DocumentReference)	Computable Contract Rules
legallyBinding[x]	0..1	Attachment | Reference(Composition | DocumentReference | QuestionnaireResponse | Contract)	Binding Contract

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Contract?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
authority	reference	The authority of the contract Contract.authority
domain	reference	The domain of the contract Contract.domain
identifier	token	The identity of the contract Contract.identifier
instantiates	uri	A source definition of the contract Contract.instantiatesUri
issued	date	The date/time the contract was issued Contract.issued
patient	reference	The identity of the subject of the contract (if a patient) Contract.subject.where(resolve() is Patient)
signer	reference	Contract Signatory Party Contract.signer.party
status	token	The status of the contract Contract.status
subject	reference	The identity of the subject of the contract Contract.subject
url	uri	The basal contract definition Contract.url

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition