Onyx Consent Authorization SAFHIR Implementation and Operations Guide
0.0.2 - ci-build

Onyx Consent Authorization SAFHIR Implementation and Operations Guide - Local Development build (v0.0.2). See the Directory of published versions

Resource Profile: PrizmCodeSystem

Defining URL:http://ig.fhir.safhir.io/ig/safhir-ocasio/StructureDefinition/PrizmCodeSystem
Version:0.0.2
Name:PrizmCodeSystem
Status:Active as of 2021-11-29T21:14:01+00:00
Definition:

Codesystem to define data segmentation rules. The client will define a codesystem with a unique identifier. The codesystem will include a list of codes from a codesystem that should be used to redact records from the results returned as apart of an API request that needs to be conformant with data segmentation rules.

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://ig.fhir.safhir.io/ig/safhir-ocasio/StructureDefinition/PrizmCodeSystem

Formal Views of Profile Content

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

This structure is derived from CodeSystem

Summary

Mandatory: 2 elements
Must-Support: 7 elements

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem 0..*CodeSystemDeclares the existence of and describes a code system or code system supplement
... identifier S1..1IdentifierA unique Identifier should be supplied for each codesystem set
... title S0..1stringhuman friendly name for codsesystem
... status S1..1codethe publication status: draft | active | retired
... content S1..1codeFixed Value = complete
Required Pattern: complete
... concept S0..*BackboneElementEnter codes to trigger redaction
.... code S1..1codeCode that identifies concept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem I0..*CodeSystemDeclares the existence of and describes a code system or code system supplement
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier SΣ1..1IdentifierA unique Identifier should be supplied for each codesystem set
... version Σ0..1stringBusiness version of the code system (Coding.version)
... name ΣI0..1stringName for this code system (computer friendly)
... title SΣ0..1stringhuman friendly name for codsesystem
... status ?!SΣ1..1codethe publication status: draft | active | retired
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..1markdownProvide a description of the purpose of this code set that links codes with a particular information sensitivity label that is subsequently used to redact sensitive information for FHIR records.
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this code system is defined
... copyright 0..1markdownUse and/or publishing restrictions
... caseSensitive Σ0..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning Σ0..1codegrouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.

... compositional Σ0..1booleanIf code system defines a compositional grammar
... versionNeeded Σ0..1booleanIf definitions are not stable
... content SΣ1..1codeFixed Value = complete
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.


Required Pattern: complete
... supplements Σ0..1canonical(CodeSystem)Canonical URL of Code System this adds designations and properties to
... count Σ0..1unsignedIntTotal concepts in the code system
... filter Σ0..*BackboneElementFilter that can be used in a value set
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeCode that identifies the filter
.... description Σ0..1stringHow or why the filter is used
.... operator Σ1..*code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.


.... value Σ1..1stringWhat to use for the value
... property Σ0..*BackboneElementAdditional information supplied about each concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeIdentifies the property on the concepts, and when referred to in operations
.... uri Σ0..1uriFormal identifier for the property
.... description Σ0..1stringWhy the property is defined, and/or what it conveys
.... type Σ1..1codecode | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.

... concept S0..*BackboneElementEnter codes to trigger redaction
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... designation 0..*BackboneElementAdditional representations for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

..... use 0..1CodingDetails how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.

..... value 1..1stringThe text value for this designation
.... property 0..*BackboneElementProperty value for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1Value of the property for this concept
...... valueCodecode
...... valueCodingCoding
...... valueStringstring
...... valueIntegerinteger
...... valueBooleanboolean
...... valueDateTimedateTime
...... valueDecimaldecimal
.... concept 0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem I0..*CodeSystemDeclares the existence of and describes a code system or code system supplement
... identifier Σ1..1IdentifierA unique Identifier should be supplied for each codesystem set
... title Σ0..1stringhuman friendly name for codsesystem
... status ?!Σ1..1codethe publication status: draft | active | retired
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... content Σ1..1codeFixed Value = complete
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.


Required Pattern: complete
... concept 0..*BackboneElementEnter codes to trigger redaction
.... code 1..1codeCode that identifies concept

doco Documentation for this format

This structure is derived from CodeSystem

Summary

Mandatory: 2 elements
Must-Support: 7 elements

Differential View

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem 0..*CodeSystemDeclares the existence of and describes a code system or code system supplement
... identifier S1..1IdentifierA unique Identifier should be supplied for each codesystem set
... title S0..1stringhuman friendly name for codsesystem
... status S1..1codethe publication status: draft | active | retired
... content S1..1codeFixed Value = complete
Required Pattern: complete
... concept S0..*BackboneElementEnter codes to trigger redaction
.... code S1..1codeCode that identifies concept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem I0..*CodeSystemDeclares the existence of and describes a code system or code system supplement
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier SΣ1..1IdentifierA unique Identifier should be supplied for each codesystem set
... version Σ0..1stringBusiness version of the code system (Coding.version)
... name ΣI0..1stringName for this code system (computer friendly)
... title SΣ0..1stringhuman friendly name for codsesystem
... status ?!SΣ1..1codethe publication status: draft | active | retired
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..1markdownProvide a description of the purpose of this code set that links codes with a particular information sensitivity label that is subsequently used to redact sensitive information for FHIR records.
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this code system is defined
... copyright 0..1markdownUse and/or publishing restrictions
... caseSensitive Σ0..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning Σ0..1codegrouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.

... compositional Σ0..1booleanIf code system defines a compositional grammar
... versionNeeded Σ0..1booleanIf definitions are not stable
... content SΣ1..1codeFixed Value = complete
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.


Required Pattern: complete
... supplements Σ0..1canonical(CodeSystem)Canonical URL of Code System this adds designations and properties to
... count Σ0..1unsignedIntTotal concepts in the code system
... filter Σ0..*BackboneElementFilter that can be used in a value set
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeCode that identifies the filter
.... description Σ0..1stringHow or why the filter is used
.... operator Σ1..*code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.


.... value Σ1..1stringWhat to use for the value
... property Σ0..*BackboneElementAdditional information supplied about each concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeIdentifies the property on the concepts, and when referred to in operations
.... uri Σ0..1uriFormal identifier for the property
.... description Σ0..1stringWhy the property is defined, and/or what it conveys
.... type Σ1..1codecode | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.

... concept S0..*BackboneElementEnter codes to trigger redaction
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... designation 0..*BackboneElementAdditional representations for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

..... use 0..1CodingDetails how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.

..... value 1..1stringThe text value for this designation
.... property 0..*BackboneElementProperty value for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1Value of the property for this concept
...... valueCodecode
...... valueCodingCoding
...... valueStringstring
...... valueIntegerinteger
...... valueBooleanboolean
...... valueDateTimedateTime
...... valueDecimaldecimal
.... concept 0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
CodeSystem.languagepreferredCommonLanguages
Max Binding: AllLanguages
CodeSystem.statusrequiredPublicationStatus
CodeSystem.jurisdictionextensibleJurisdiction ValueSet
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
CodeSystem.contentrequiredPattern: complete
CodeSystem.filter.operatorrequiredFilterOperator
CodeSystem.property.typerequiredPropertyType
CodeSystem.concept.designation.languagepreferredCommonLanguages
Max Binding: AllLanguages
CodeSystem.concept.designation.useextensibleDesignationUse