FHIR Implementation Guide for HCX
0.9.0 - CI Build

FHIR Implementation Guide for HCX - Local Development build (v0.9.0). See the Directory of published versions

Extension: HCX Diagnostic DocumentsExtension

Extension to attach supporting Diagnostic documents.

The official URL for this extension is:

https://ig.hcxprotocol.io/v0.9/StructureDefinition-HCXDiagnosticDocumentsExtension.html

Status: active
Extension maintained by: HCX Open Community

Context of Use

This extension may be used on the following element(s):

  • Element ID

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Mandatory: 2 elements (4 nested mandatory elements)
Fixed Value: 6 elements
Prohibited: 1 element

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension to attach supporting Diagnostic documents.
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:diagnosticDocumentCode 1..*ExtensionDiagnostic Documents
.... url 1..1uri"ClinicalDiagnosticDocumentCode"
.... value[x] 1..1CodeableConceptDiagnostic Document Code
Binding: ClinicalDiagnosticsDocumentCodes (extensible)
... extension:required 0..1ExtensionRequired Flag
.... url 1..1uri"ClinicalDiagnosticDocumentRequiredFlag"
.... value[x] 1..1booleanDocument Required Flag
.... url 1..1uri"ClinicalDiagnosticDocumentMimeType"
.... value[x] 1..1codeDocument Mime type code
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

... extension:claimUse 0..1ExtensionClaim use code
.... url 1..1uri"ClinicalDiagnosticDocumentClaimUse"
.... value[x] 1..1codeClaim use code
Binding: Use (preferred)
... extension:documentationUrl 0..1ExtensionRequired Flag
.... url 1..1uri"DocumentationUrl"
.... value[x] 1..1urlDocumention URL
... url 1..1uri"https://ig.hcxprotocol.io/v0.9/StructureDefinition-HCXDiagnosticDocumentsExtension.html"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension to attach supporting Diagnostic documents.
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:diagnosticDocumentCode 1..*ExtensionDiagnostic Documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ClinicalDiagnosticDocumentCode"
.... value[x] 1..1CodeableConceptDiagnostic Document Code
Binding: ClinicalDiagnosticsDocumentCodes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ClinicalDiagnosticDocumentRequiredFlag"
.... value[x] 1..1booleanDocument Required Flag
... extension:mimeType 0..*ExtensionMime type of the document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ClinicalDiagnosticDocumentMimeType"
.... value[x] 1..1codeDocument Mime type code
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

... extension:claimUse 0..1ExtensionClaim use code
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ClinicalDiagnosticDocumentClaimUse"
.... value[x] 1..1codeClaim use code
Binding: Use (preferred)
... extension:documentationUrl 0..1ExtensionRequired Flag
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"DocumentationUrl"
.... value[x] 1..1urlDocumention URL
... url 1..1uri"https://ig.hcxprotocol.io/v0.9/StructureDefinition-HCXDiagnosticDocumentsExtension.html"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 2 elements (4 nested mandatory elements)
Fixed Value: 6 elements
Prohibited: 1 element

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension to attach supporting Diagnostic documents.
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:diagnosticDocumentCode 1..*ExtensionDiagnostic Documents
.... url 1..1uri"ClinicalDiagnosticDocumentCode"
.... value[x] 1..1CodeableConceptDiagnostic Document Code
Binding: ClinicalDiagnosticsDocumentCodes (extensible)
... extension:required 0..1ExtensionRequired Flag
.... url 1..1uri"ClinicalDiagnosticDocumentRequiredFlag"
.... value[x] 1..1booleanDocument Required Flag
.... url 1..1uri"ClinicalDiagnosticDocumentMimeType"
.... value[x] 1..1codeDocument Mime type code
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

... extension:claimUse 0..1ExtensionClaim use code
.... url 1..1uri"ClinicalDiagnosticDocumentClaimUse"
.... value[x] 1..1codeClaim use code
Binding: Use (preferred)
... extension:documentationUrl 0..1ExtensionRequired Flag
.... url 1..1uri"DocumentationUrl"
.... value[x] 1..1urlDocumention URL
... url 1..1uri"https://ig.hcxprotocol.io/v0.9/StructureDefinition-HCXDiagnosticDocumentsExtension.html"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension to attach supporting Diagnostic documents.
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:diagnosticDocumentCode 1..*ExtensionDiagnostic Documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ClinicalDiagnosticDocumentCode"
.... value[x] 1..1CodeableConceptDiagnostic Document Code
Binding: ClinicalDiagnosticsDocumentCodes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ClinicalDiagnosticDocumentRequiredFlag"
.... value[x] 1..1booleanDocument Required Flag
... extension:mimeType 0..*ExtensionMime type of the document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ClinicalDiagnosticDocumentMimeType"
.... value[x] 1..1codeDocument Mime type code
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

... extension:claimUse 0..1ExtensionClaim use code
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ClinicalDiagnosticDocumentClaimUse"
.... value[x] 1..1codeClaim use code
Binding: Use (preferred)
... extension:documentationUrl 0..1ExtensionRequired Flag
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"DocumentationUrl"
.... value[x] 1..1urlDocumention URL
... url 1..1uri"https://ig.hcxprotocol.io/v0.9/StructureDefinition-HCXDiagnosticDocumentsExtension.html"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:diagnosticDocumentCode.value[x]extensibleClinicalDiagnosticsDocumentCodes
Extension.extension:mimeType.value[x]requiredMime Types (a valid code from urn:ietf:bcp:13)
Extension.extension:claimUse.value[x]preferredUse

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()