Provider Connect Australia (PCA) - Local Development build (v25.2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PCA Information Use Statement

Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-information-use-statement Version: 25.2.0.0
Active as of 2025-10-23 Computable Name: PcaInformationUseStatement

Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This profile of Contract defines an information use statement for a PCA Partner Service. An information use statement is a policy statement by the subscriber that describes how subscribers will use the information that is disclosed to this service.

Must support

The meaning of the presence or absence of the must support flag is described in Must support.

Extensions

No extensions have been introduced in this profile.

Supported interactions

Supported service interactions for this profile are defined in the following capability statements:

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Contract 0..* Contract An information use statement
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... version SΣ 1..1 string Business edition
... subject SΣC 1..1 Reference(PCA Partner Service) Service this information use statement is about
Constraints: inv-pca-1
... type SΣ 1..1 CodeableConcept Legal instrument category
Binding: ContractTypeCodes (example): List of overall contract codes.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-contract-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IUS
..... display 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
... legal S 1..1 BackboneElement Contract Legal Language
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... content[x] 1..1 Attachment Contract Legal Text
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/xhtml+xml
..... data 1..1 base64Binary Information use statement narrative

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Contract.status Base required Contract Resource Status Codes 📍4.0.1 FHIR Std.
Contract.type Base example Contract Type Codes 📍4.0.1 FHIR Std.
Contract.legal.content[x].​contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
inv-pca-1 error Contract.subject subject shall be a relative reference to a HealthcareService reference.startsWith('HealthcareService/')

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Contract 0..* Contract An information use statement
... version S 1..1 string Business edition
... subject SC 1..1 Reference(PCA Partner Service) Service this information use statement is about
Constraints: inv-pca-1
... type S 1..1 CodeableConcept Legal instrument category
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-contract-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IUS
.... content[x] 1..1 Attachment Contract Legal Text
..... contentType 1..1 code Mime type of the content, with charset etc.
Fixed Value: application/xhtml+xml
..... data 1..1 base64Binary Information use statement narrative
..... url 0..0

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
inv-pca-1 error Contract.subject subject shall be a relative reference to a HealthcareService reference.startsWith('HealthcareService/')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Contract 0..* Contract An information use statement
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Contract number
... url 0..1 uri Basal definition
... version SΣ 1..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 SΣC 1..1 Reference(PCA Partner Service) Service this information use statement is about
Constraints: inv-pca-1
... 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.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-contract-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IUS
..... display 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(4.0.1) 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 S 1..1 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 Attachment Contract Legal Text
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/xhtml+xml
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 1..1 base64Binary Information use statement narrative
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
... 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

Path Status Usage ValueSet Version Source
Contract.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Contract.status Base required Contract Resource Status Codes 📍4.0.1 FHIR Std.
Contract.legalState Base extensible Contract Resource Legal State codes 📍4.0.1 FHIR Std.
Contract.contentDerivative Base example Contract Content Derivation Codes 📍4.0.1 FHIR Std.
Contract.expirationType Base example Contract Resource Expiration Type codes 📍4.0.1 FHIR Std.
Contract.scope Base example Contract Resource Scope codes 📍4.0.1 FHIR Std.
Contract.type Base example Contract Type Codes 📍4.0.1 FHIR Std.
Contract.subType Base example Contract Subtype Codes 📍4.0.1 FHIR Std.
Contract.contentDefinition.​type Base example Contract Resource Definition Type codes 📍4.0.1 FHIR Std.
Contract.contentDefinition.​subType Base example Contract Resource Definition Subtype codes 📍4.0.1 FHIR Std.
Contract.contentDefinition.​publicationStatus Base required Contract Resource Publication Status codes 📍4.0.1 FHIR Std.
Contract.term.type Base example Contract Term Type Codes 📍4.0.1 FHIR Std.
Contract.term.subType Base example Contract Term Subtype Codes 📍4.0.1 FHIR Std.
Contract.term.securityLabel.​classification Base example Contract Resource Scope codes 📍4.0.1 FHIR Std.
Contract.term.securityLabel.​category Base example Contract Resource Scope codes 📍4.0.1 FHIR Std.
Contract.term.securityLabel.​control Base example Contract Resource Security Control codes 📍4.0.1 FHIR Std.
Contract.term.offer.​party.role Base example Contract Resource Party Role codes 📍4.0.1 FHIR Std.
Contract.term.offer.​type Base example Contract Term Type Codes 📍4.0.1 FHIR Std.
Contract.term.offer.​decision Base extensible ActConsentDirective 📦3.0.0 THO v6.5
Contract.term.offer.​decisionMode Base example Contract Resource Decision Mode codes 📍4.0.1 FHIR Std.
Contract.term.asset.​scope Base example Contract Resource Asset Scope codes 📍4.0.1 FHIR Std.
Contract.term.asset.​type Base example Contract Resource Asset Type codes 📍4.0.1 FHIR Std.
Contract.term.asset.​subtype Base example Contract Resource Asset Sub-Type codes 📍4.0.1 FHIR Std.
Contract.term.asset.​relationship Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Contract.term.asset.​context.code Base example Contract Resource Asset Context codes 📍4.0.1 FHIR Std.
Contract.term.asset.​periodType Base example Contract Resource Asset Availiability codes 📍4.0.1 FHIR Std.
Contract.term.action.​type Base example Contract Action Codes 📍4.0.1 FHIR Std.
Contract.term.action.​subject.role Base example Contract Actor Role Codes 📍4.0.1 FHIR Std.
Contract.term.action.​intent Base example PurposeOfUse 📦3.1.0 THO v6.5
Contract.term.action.​status Base example Contract Resource Action Status codes 📍4.0.1 FHIR Std.
Contract.term.action.​performerType Base example Provenance participant type 📍4.0.1 FHIR Std.
Contract.term.action.​performerRole Base example Provenance participant role 📍4.0.1 FHIR Std.
Contract.term.action.​reasonCode Base example PurposeOfUse 📦3.1.0 THO v6.5
Contract.signer.type Base preferred Contract Signer Type Codes 📍4.0.1 FHIR Std.
Contract.legal.content[x].​contentType Base required MimeType 📍4.0.1 FHIR Std.
Contract.legal.content[x].​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
inv-pca-1 error Contract.subject subject shall be a relative reference to a HealthcareService reference.startsWith('HealthcareService/')

This structure is derived from Contract

Summary

Mandatory: 6 elements
Must-Support: 4 elements
Fixed: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Contract 0..* Contract An information use statement
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... version SΣ 1..1 string Business edition
... subject SΣC 1..1 Reference(PCA Partner Service) Service this information use statement is about
Constraints: inv-pca-1
... type SΣ 1..1 CodeableConcept Legal instrument category
Binding: ContractTypeCodes (example): List of overall contract codes.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-contract-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IUS
..... display 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
... legal S 1..1 BackboneElement Contract Legal Language
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... content[x] 1..1 Attachment Contract Legal Text
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/xhtml+xml
..... data 1..1 base64Binary Information use statement narrative

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Contract.status Base required Contract Resource Status Codes 📍4.0.1 FHIR Std.
Contract.type Base example Contract Type Codes 📍4.0.1 FHIR Std.
Contract.legal.content[x].​contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
inv-pca-1 error Contract.subject subject shall be a relative reference to a HealthcareService reference.startsWith('HealthcareService/')

Differential View

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Contract 0..* Contract An information use statement
... version S 1..1 string Business edition
... subject SC 1..1 Reference(PCA Partner Service) Service this information use statement is about
Constraints: inv-pca-1
... type S 1..1 CodeableConcept Legal instrument category
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-contract-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IUS
.... content[x] 1..1 Attachment Contract Legal Text
..... contentType 1..1 code Mime type of the content, with charset etc.
Fixed Value: application/xhtml+xml
..... data 1..1 base64Binary Information use statement narrative
..... url 0..0

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
inv-pca-1 error Contract.subject subject shall be a relative reference to a HealthcareService reference.startsWith('HealthcareService/')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Contract 0..* Contract An information use statement
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Contract number
... url 0..1 uri Basal definition
... version SΣ 1..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 SΣC 1..1 Reference(PCA Partner Service) Service this information use statement is about
Constraints: inv-pca-1
... 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.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-contract-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IUS
..... display 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(4.0.1) 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 S 1..1 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 Attachment Contract Legal Text
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/xhtml+xml
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 1..1 base64Binary Information use statement narrative
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
... 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

Path Status Usage ValueSet Version Source
Contract.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Contract.status Base required Contract Resource Status Codes 📍4.0.1 FHIR Std.
Contract.legalState Base extensible Contract Resource Legal State codes 📍4.0.1 FHIR Std.
Contract.contentDerivative Base example Contract Content Derivation Codes 📍4.0.1 FHIR Std.
Contract.expirationType Base example Contract Resource Expiration Type codes 📍4.0.1 FHIR Std.
Contract.scope Base example Contract Resource Scope codes 📍4.0.1 FHIR Std.
Contract.type Base example Contract Type Codes 📍4.0.1 FHIR Std.
Contract.subType Base example Contract Subtype Codes 📍4.0.1 FHIR Std.
Contract.contentDefinition.​type Base example Contract Resource Definition Type codes 📍4.0.1 FHIR Std.
Contract.contentDefinition.​subType Base example Contract Resource Definition Subtype codes 📍4.0.1 FHIR Std.
Contract.contentDefinition.​publicationStatus Base required Contract Resource Publication Status codes 📍4.0.1 FHIR Std.
Contract.term.type Base example Contract Term Type Codes 📍4.0.1 FHIR Std.
Contract.term.subType Base example Contract Term Subtype Codes 📍4.0.1 FHIR Std.
Contract.term.securityLabel.​classification Base example Contract Resource Scope codes 📍4.0.1 FHIR Std.
Contract.term.securityLabel.​category Base example Contract Resource Scope codes 📍4.0.1 FHIR Std.
Contract.term.securityLabel.​control Base example Contract Resource Security Control codes 📍4.0.1 FHIR Std.
Contract.term.offer.​party.role Base example Contract Resource Party Role codes 📍4.0.1 FHIR Std.
Contract.term.offer.​type Base example Contract Term Type Codes 📍4.0.1 FHIR Std.
Contract.term.offer.​decision Base extensible ActConsentDirective 📦3.0.0 THO v6.5
Contract.term.offer.​decisionMode Base example Contract Resource Decision Mode codes 📍4.0.1 FHIR Std.
Contract.term.asset.​scope Base example Contract Resource Asset Scope codes 📍4.0.1 FHIR Std.
Contract.term.asset.​type Base example Contract Resource Asset Type codes 📍4.0.1 FHIR Std.
Contract.term.asset.​subtype Base example Contract Resource Asset Sub-Type codes 📍4.0.1 FHIR Std.
Contract.term.asset.​relationship Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Contract.term.asset.​context.code Base example Contract Resource Asset Context codes 📍4.0.1 FHIR Std.
Contract.term.asset.​periodType Base example Contract Resource Asset Availiability codes 📍4.0.1 FHIR Std.
Contract.term.action.​type Base example Contract Action Codes 📍4.0.1 FHIR Std.
Contract.term.action.​subject.role Base example Contract Actor Role Codes 📍4.0.1 FHIR Std.
Contract.term.action.​intent Base example PurposeOfUse 📦3.1.0 THO v6.5
Contract.term.action.​status Base example Contract Resource Action Status codes 📍4.0.1 FHIR Std.
Contract.term.action.​performerType Base example Provenance participant type 📍4.0.1 FHIR Std.
Contract.term.action.​performerRole Base example Provenance participant role 📍4.0.1 FHIR Std.
Contract.term.action.​reasonCode Base example PurposeOfUse 📦3.1.0 THO v6.5
Contract.signer.type Base preferred Contract Signer Type Codes 📍4.0.1 FHIR Std.
Contract.legal.content[x].​contentType Base required MimeType 📍4.0.1 FHIR Std.
Contract.legal.content[x].​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
inv-pca-1 error Contract.subject subject shall be a relative reference to a HealthcareService reference.startsWith('HealthcareService/')

This structure is derived from Contract

Summary

Mandatory: 6 elements
Must-Support: 4 elements
Fixed: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Additional search parameters defined for this resource profile:

Name Type Description Expression In Common
version string The version of the contract Contract.version