FHIR Implementation Guide for HCX
0.7.1 - CI Build
FHIR Implementation Guide for HCX
0.7.1 - CI Build
FHIR Implementation Guide for HCX - Local Development build (v0.7.1). See the Directory of published versions
Extension to add a list of proof of Identification Documents.
The official URL for this extension is:
https://ig.hcxprotocol.io/v0.7.1/StructureDefinition-HCXProofOfIdentificationExtension.html
Status: active
Extension maintained by: HCX Open Community
Context of Use
This extension may be used on the following element(s):
Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension | Extension to add a list of proof of Identification Documents. | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  extension:proofOfIdDocumentCode | 1..* | Extension | POID Document | |
  url | 1..1 | uri | "ProofOfIdentificationDocumentCode" | |
  value[x] | 1..1 | CodeableConcept | POID Document Code Binding: ProofOfIdentityCodes (extensible) | |
| extension:required | 0..1 | Extension | Required Flag | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentRequiredFlag" | |
 value[x] | 1..1 | boolean | POID Document Required Flag | |
| extension:mimeType | 0..* | Extension | Mime type of the document | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentMimeType" | |
| value[x] | 1..1 | code | Document Mime type code Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |
| extension:claimUse | 0..1 | Extension | Claim use code | |
| url | 1..1 | uri | "ClinicalDiagnosticDocumentClaimUse" | |
| value[x] | 1..1 | code | Claim use code Binding: Use (preferred) | |
| extension:documentationUrl | 0..1 | Extension | Required Flag | |
| url | 1..1 | uri | "DocumentationUrl" | |
| value[x] | 1..1 | url | Documention URL | |
| url | 1..1 | uri | "https://ig.hcxprotocol.io/v0.7.1/StructureDefinition-HCXProofOfIdentificationExtension.html" | |
 value[x] | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Extension to add a list of proof of Identification Documents. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:proofOfIdDocumentCode | 1..* | Extension | POID Document | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentCode" | |
| value[x] | 1..1 | CodeableConcept | POID Document Code Binding: ProofOfIdentityCodes (extensible) | |
| extension:required | 0..1 | Extension | Required Flag | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentRequiredFlag" | |
| value[x] | 1..1 | boolean | POID Document Required Flag | |
| extension:mimeType | 0..* | Extension | Mime type of the document | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentMimeType" | |
| value[x] | 1..1 | code | Document Mime type code Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |
| extension:claimUse | 0..1 | Extension | Claim use code | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "ClinicalDiagnosticDocumentClaimUse" | |
| value[x] | 1..1 | code | Claim use code Binding: Use (preferred) | |
| extension:documentationUrl | 0..1 | Extension | Required Flag | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "DocumentationUrl" | |
| value[x] | 1..1 | url | Documention URL | |
| url | 1..1 | uri | "https://ig.hcxprotocol.io/v0.7.1/StructureDefinition-HCXProofOfIdentificationExtension.html" | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Extension to add a list of proof of Identification Documents. | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:proofOfIdDocumentCode | 1..* | Extension | POID Document | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentCode" | |
| value[x] | 1..1 | CodeableConcept | POID Document Code Binding: ProofOfIdentityCodes (extensible) | |
| extension:required | 0..1 | Extension | Required Flag | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentRequiredFlag" | |
| value[x] | 1..1 | boolean | POID Document Required Flag | |
| extension:mimeType | 0..* | Extension | Mime type of the document | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentMimeType" | |
| value[x] | 1..1 | code | Document Mime type code Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |
| extension:claimUse | 0..1 | Extension | Claim use code | |
| url | 1..1 | uri | "ClinicalDiagnosticDocumentClaimUse" | |
| value[x] | 1..1 | code | Claim use code Binding: Use (preferred) | |
| extension:documentationUrl | 0..1 | Extension | Required Flag | |
| url | 1..1 | uri | "DocumentationUrl" | |
| value[x] | 1..1 | url | Documention URL | |
| url | 1..1 | uri | "https://ig.hcxprotocol.io/v0.7.1/StructureDefinition-HCXProofOfIdentificationExtension.html" | |
| value[x] | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Extension to add a list of proof of Identification Documents. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:proofOfIdDocumentCode | 1..* | Extension | POID Document | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentCode" | |
| value[x] | 1..1 | CodeableConcept | POID Document Code Binding: ProofOfIdentityCodes (extensible) | |
| extension:required | 0..1 | Extension | Required Flag | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentRequiredFlag" | |
| value[x] | 1..1 | boolean | POID Document Required Flag | |
| extension:mimeType | 0..* | Extension | Mime type of the document | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "ProofOfIdentificationDocumentMimeType" | |
| value[x] | 1..1 | code | Document Mime type code Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |
| extension:claimUse | 0..1 | Extension | Claim use code | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "ClinicalDiagnosticDocumentClaimUse" | |
| value[x] | 1..1 | code | Claim use code Binding: Use (preferred) | |
| extension:documentationUrl | 0..1 | Extension | Required Flag | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "DocumentationUrl" | |
| value[x] | 1..1 | url | Documention URL | |
| url | 1..1 | uri | "https://ig.hcxprotocol.io/v0.7.1/StructureDefinition-HCXProofOfIdentificationExtension.html" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Extension.extension:proofOfIdDocumentCode.value[x] | extensible | ProofOfIdentityCodes |
| Extension.extension:mimeType.value[x] | required | Mime Types (a valid code from urn:ietf:bcp:13) |
| Extension.extension:claimUse.value[x] | preferred | Use |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |