Provider Connect Australia (PCA)
2.4.3 - active
Provider Connect Australia (PCA)
2.4.3 - active
Provider Connect Australia (PCA) - Local Development build (v2.4.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-information-use-statement | Version: 2.4.3 | |||
| Active as of 2024-03-19 | 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.
The meaning of the presence or absence of the must support flag is described in Must support.
No extensions have been introduced in this profile.
Supported service interactions for this profile are defined in the following capability statements:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Contract
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Contract | 0..* | Contract | An information use statement | |
  id | S | 0..1 | id | Logical id of this artifact |
 meta | S | 0..1 | Meta | Metadata about the resource |
 versionId | S | 0..1 | id | Version specific identifier |
| lastUpdated | S | 0..1 | instant | When the resource version last changed |
 profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-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 inv-pca-1: subject shall be a relative reference to a HealthcareService |
| 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 | |
| legal | S | 1..1 | BackboneElement | Contract Legal Language |
 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 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-pca-1 | error | Contract.subject | subject shall be a relative reference to a HealthcareService : reference.startsWith('HealthcareService/') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Contract | 0..* | Contract | An information use statement | |
 id | SΣ | 0..1 | id | Logical id of this artifact |
| meta | SΣ | 0..1 | Meta | Metadata about the resource |
| versionId | SΣ | 0..1 | id | Version specific identifier |
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-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 |
| 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. |
| subject | SΣC | 1..1 | Reference(PCA Partner Service) | Service this information use statement is about inv-pca-1: subject shall be a relative reference to a HealthcareService |
| type | SΣ | 1..1 | CodeableConcept | Legal instrument category Binding: ContractTypeCodes (example): List of overall contract codes. 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 | |
| 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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1from the FHIR Standard | |
| Contract.type | example | Pattern: IUShttp://hl7.org/fhir/ValueSet/contract-typefrom the FHIR Standard | |
| Contract.legal.content[x].contentType | required | Fixed Value: application/xhtml+xmlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-pca-1 | error | Contract.subject | subject shall be a relative reference to a HealthcareService : reference.startsWith('HealthcareService/') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Contract | 0..* | Contract | An information use statement | |||||
| id | SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | SΣ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-information-use-statement | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| 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 inv-pca-1: subject shall be a relative reference to a HealthcareService | ||||
| 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 | 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.
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) | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Contract.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Contract.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Contract.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1from the FHIR Standard | ||||
| Contract.legalState | extensible | ContractResourceLegalStateCodeshttp://hl7.org/fhir/ValueSet/contract-legalstatefrom the FHIR Standard | ||||
| Contract.contentDerivative | example | ContractContentDerivationCodeshttp://hl7.org/fhir/ValueSet/contract-content-derivativefrom the FHIR Standard | ||||
| Contract.expirationType | example | ContractResourceExpirationTypeCodeshttp://hl7.org/fhir/ValueSet/contract-expiration-typefrom the FHIR Standard | ||||
| Contract.scope | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-scopefrom the FHIR Standard | ||||
| Contract.type | example | Pattern: IUShttp://hl7.org/fhir/ValueSet/contract-typefrom the FHIR Standard | ||||
| Contract.subType | example | ContractSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-subtypefrom the FHIR Standard | ||||
| Contract.contentDefinition.type | example | ContractResourceDefinitionTypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-typefrom the FHIR Standard | ||||
| Contract.contentDefinition.subType | example | ContractResourceDefinitionSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-subtypefrom the FHIR Standard | ||||
| Contract.contentDefinition.publicationStatus | required | ContractResourcePublicationStatusCodeshttp://hl7.org/fhir/ValueSet/contract-publicationstatus|4.0.1from the FHIR Standard | ||||
| Contract.term.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-typefrom the FHIR Standard | ||||
| Contract.term.subType | example | ContractTermSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-subtypefrom the FHIR Standard | ||||
| Contract.term.securityLabel.classification | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-classificationfrom the FHIR Standard | ||||
| Contract.term.securityLabel.category | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-categoryfrom the FHIR Standard | ||||
| Contract.term.securityLabel.control | example | ContractResourceSecurityControlCodeshttp://hl7.org/fhir/ValueSet/contract-security-controlfrom the FHIR Standard | ||||
| Contract.term.offer.party.role | example | ContractResourcePartyRoleCodeshttp://hl7.org/fhir/ValueSet/contract-party-rolefrom the FHIR Standard | ||||
| Contract.term.offer.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-typefrom the FHIR Standard | ||||
| Contract.term.offer.decision | extensible | ActConsentDirectivehttp://terminology.hl7.org/ValueSet/v3-ActConsentDirective | ||||
| Contract.term.offer.decisionMode | example | ContractResourceDecisionModeCodeshttp://hl7.org/fhir/ValueSet/contract-decision-modefrom the FHIR Standard | ||||
| Contract.term.asset.scope | example | ContractResourceAssetScopeCodeshttp://hl7.org/fhir/ValueSet/contract-assetscopefrom the FHIR Standard | ||||
| Contract.term.asset.type | example | ContractResourceAssetTypeCodeshttp://hl7.org/fhir/ValueSet/contract-assettypefrom the FHIR Standard | ||||
| Contract.term.asset.subtype | example | ContractResourceAssetSub-TypeCodeshttp://hl7.org/fhir/ValueSet/contract-assetsubtypefrom the FHIR Standard | ||||
| Contract.term.asset.relationship | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classfrom the FHIR Standard | ||||
| Contract.term.asset.context.code | example | ContractResourceAssetContextCodeshttp://hl7.org/fhir/ValueSet/contract-assetcontextfrom the FHIR Standard | ||||
| Contract.term.asset.periodType | example | ContractResourceAssetAvailiabilityCodeshttp://hl7.org/fhir/ValueSet/asset-availabilityfrom the FHIR Standard | ||||
| Contract.term.action.type | example | ContractActionCodeshttp://hl7.org/fhir/ValueSet/contract-actionfrom the FHIR Standard | ||||
| Contract.term.action.subject.role | example | ContractActorRoleCodeshttp://hl7.org/fhir/ValueSet/contract-actorrolefrom the FHIR Standard | ||||
| Contract.term.action.intent | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Contract.term.action.status | example | ContractResourceActionStatusCodeshttp://hl7.org/fhir/ValueSet/contract-actionstatusfrom the FHIR Standard | ||||
| Contract.term.action.performerType | example | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | ||||
| Contract.term.action.performerRole | example | ProvenanceParticipantRolehttp://hl7.org/fhir/ValueSet/provenance-agent-rolefrom the FHIR Standard | ||||
| Contract.term.action.reasonCode | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Contract.signer.type | preferred | ContractSignerTypeCodeshttp://hl7.org/fhir/ValueSet/contract-signer-typefrom the FHIR Standard | ||||
| Contract.legal.content[x].contentType | required | Fixed Value: application/xhtml+xmlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| Contract.legal.content[x].language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-pca-1 | error | Contract.subject | subject shall be a relative reference to a HealthcareService : reference.startsWith('HealthcareService/') |
This structure is derived from Contract
Differential View
This structure is derived from Contract
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Contract | 0..* | Contract | An information use statement | |
| id | S | 0..1 | id | Logical id of this artifact |
| meta | S | 0..1 | Meta | Metadata about the resource |
| versionId | S | 0..1 | id | Version specific identifier |
| lastUpdated | S | 0..1 | instant | When the resource version last changed |
| profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-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 inv-pca-1: subject shall be a relative reference to a HealthcareService |
| 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 | |
| legal | S | 1..1 | BackboneElement | Contract Legal Language |
| 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 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-pca-1 | error | Contract.subject | subject shall be a relative reference to a HealthcareService : reference.startsWith('HealthcareService/') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Contract | 0..* | Contract | An information use statement | |
| id | SΣ | 0..1 | id | Logical id of this artifact |
| meta | SΣ | 0..1 | Meta | Metadata about the resource |
| versionId | SΣ | 0..1 | id | Version specific identifier |
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-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 |
| 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. |
| subject | SΣC | 1..1 | Reference(PCA Partner Service) | Service this information use statement is about inv-pca-1: subject shall be a relative reference to a HealthcareService |
| type | SΣ | 1..1 | CodeableConcept | Legal instrument category Binding: ContractTypeCodes (example): List of overall contract codes. 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 | |
| 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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1from the FHIR Standard | |
| Contract.type | example | Pattern: IUShttp://hl7.org/fhir/ValueSet/contract-typefrom the FHIR Standard | |
| Contract.legal.content[x].contentType | required | Fixed Value: application/xhtml+xmlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-pca-1 | error | Contract.subject | subject shall be a relative reference to a HealthcareService : reference.startsWith('HealthcareService/') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Contract | 0..* | Contract | An information use statement | |||||
| id | SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | SΣ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-information-use-statement | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| 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 inv-pca-1: subject shall be a relative reference to a HealthcareService | ||||
| 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 | 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.
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) | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Contract.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Contract.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Contract.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Contract.status | required | ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|4.0.1from the FHIR Standard | ||||
| Contract.legalState | extensible | ContractResourceLegalStateCodeshttp://hl7.org/fhir/ValueSet/contract-legalstatefrom the FHIR Standard | ||||
| Contract.contentDerivative | example | ContractContentDerivationCodeshttp://hl7.org/fhir/ValueSet/contract-content-derivativefrom the FHIR Standard | ||||
| Contract.expirationType | example | ContractResourceExpirationTypeCodeshttp://hl7.org/fhir/ValueSet/contract-expiration-typefrom the FHIR Standard | ||||
| Contract.scope | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-scopefrom the FHIR Standard | ||||
| Contract.type | example | Pattern: IUShttp://hl7.org/fhir/ValueSet/contract-typefrom the FHIR Standard | ||||
| Contract.subType | example | ContractSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-subtypefrom the FHIR Standard | ||||
| Contract.contentDefinition.type | example | ContractResourceDefinitionTypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-typefrom the FHIR Standard | ||||
| Contract.contentDefinition.subType | example | ContractResourceDefinitionSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-definition-subtypefrom the FHIR Standard | ||||
| Contract.contentDefinition.publicationStatus | required | ContractResourcePublicationStatusCodeshttp://hl7.org/fhir/ValueSet/contract-publicationstatus|4.0.1from the FHIR Standard | ||||
| Contract.term.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-typefrom the FHIR Standard | ||||
| Contract.term.subType | example | ContractTermSubtypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-subtypefrom the FHIR Standard | ||||
| Contract.term.securityLabel.classification | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-classificationfrom the FHIR Standard | ||||
| Contract.term.securityLabel.category | example | ContractResourceScopeCodeshttp://hl7.org/fhir/ValueSet/contract-security-categoryfrom the FHIR Standard | ||||
| Contract.term.securityLabel.control | example | ContractResourceSecurityControlCodeshttp://hl7.org/fhir/ValueSet/contract-security-controlfrom the FHIR Standard | ||||
| Contract.term.offer.party.role | example | ContractResourcePartyRoleCodeshttp://hl7.org/fhir/ValueSet/contract-party-rolefrom the FHIR Standard | ||||
| Contract.term.offer.type | example | ContractTermTypeCodeshttp://hl7.org/fhir/ValueSet/contract-term-typefrom the FHIR Standard | ||||
| Contract.term.offer.decision | extensible | ActConsentDirectivehttp://terminology.hl7.org/ValueSet/v3-ActConsentDirective | ||||
| Contract.term.offer.decisionMode | example | ContractResourceDecisionModeCodeshttp://hl7.org/fhir/ValueSet/contract-decision-modefrom the FHIR Standard | ||||
| Contract.term.asset.scope | example | ContractResourceAssetScopeCodeshttp://hl7.org/fhir/ValueSet/contract-assetscopefrom the FHIR Standard | ||||
| Contract.term.asset.type | example | ContractResourceAssetTypeCodeshttp://hl7.org/fhir/ValueSet/contract-assettypefrom the FHIR Standard | ||||
| Contract.term.asset.subtype | example | ContractResourceAssetSub-TypeCodeshttp://hl7.org/fhir/ValueSet/contract-assetsubtypefrom the FHIR Standard | ||||
| Contract.term.asset.relationship | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classfrom the FHIR Standard | ||||
| Contract.term.asset.context.code | example | ContractResourceAssetContextCodeshttp://hl7.org/fhir/ValueSet/contract-assetcontextfrom the FHIR Standard | ||||
| Contract.term.asset.periodType | example | ContractResourceAssetAvailiabilityCodeshttp://hl7.org/fhir/ValueSet/asset-availabilityfrom the FHIR Standard | ||||
| Contract.term.action.type | example | ContractActionCodeshttp://hl7.org/fhir/ValueSet/contract-actionfrom the FHIR Standard | ||||
| Contract.term.action.subject.role | example | ContractActorRoleCodeshttp://hl7.org/fhir/ValueSet/contract-actorrolefrom the FHIR Standard | ||||
| Contract.term.action.intent | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Contract.term.action.status | example | ContractResourceActionStatusCodeshttp://hl7.org/fhir/ValueSet/contract-actionstatusfrom the FHIR Standard | ||||
| Contract.term.action.performerType | example | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | ||||
| Contract.term.action.performerRole | example | ProvenanceParticipantRolehttp://hl7.org/fhir/ValueSet/provenance-agent-rolefrom the FHIR Standard | ||||
| Contract.term.action.reasonCode | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Contract.signer.type | preferred | ContractSignerTypeCodeshttp://hl7.org/fhir/ValueSet/contract-signer-typefrom the FHIR Standard | ||||
| Contract.legal.content[x].contentType | required | Fixed Value: application/xhtml+xmlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| Contract.legal.content[x].language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-pca-1 | error | Contract.subject | subject shall be a relative reference to a HealthcareService : reference.startsWith('HealthcareService/') |
This structure is derived from Contract
Other representations of profile: CSV, Excel, Schematron
Additional search parameters defined for this resource profile:
| Name | Type | Description | Expression | In Common |
|---|---|---|---|---|
| version | string | The version of the contract | Contract.version |
IG © 2023+ Australian Digital Health Agency. Package pca.digitalhealth.gov.au#2.4.3 based on FHIR 4.0.1. Generated 2024-03-19
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
