MAIA 1.5 Schnittstellendefinition

Maia Hidden-Reason

An extension to flag reasons why specific rule-based evaluation has to be hidden or withheld.

Metadaten

CanonicalURL	https://tiplu.de/fhir/maia/StructureDefinition/MaiaHiddenReason
Kontext	RiskAssessment
Status	draft
Version	1.0.0
Herausgeber	Tiplu GmbH

Inhalt

MaiaHiddenReason (Extension)	?! I		Extension	Element id Extension Short description Maia Hidden-Reason Definition An extension to flag reasons why specific rule-based evaluation has to be hidden or withheld. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Extension.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..0	Extension	There are no (further) constraints on this element Element id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value https://tiplu.de/fhir/maia/StructureDefinition/MaiaHiddenReason Mappings rim: N/A
value[x]		1..1		There are no (further) constraints on this element Element id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valueCodeableConcept			CodeableConcept	Data type CodeableConcept
id		0..1	string	There are no (further) constraints on this element Element id Extension.value[x].id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.value[x].extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
coding	Σ	1..*	Coding	Element id Extension.value[x].coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data type Coding Sliced: Unordered, Open, by $this(Pattern) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Reason	Σ	1..1	CodingBindingPattern	Element id Extension.value[x].coding:Reason Short description Coding representing the reason for hiding the information. Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Specifies a coded reason, from a controlled vocabulary, explaining why the content has to be hidden. Data type Coding Binding MaiaHiddenReasonVS (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern { "system": "https://tiplu.de/fhir/maia/CodeSystem/MaiaHiddenReasonCS" } Mappings v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	There are no (further) constraints on this element Element id Extension.value[x].coding:Reason.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.value[x].coding:Reason.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
system	Σ	1..1	uriPattern	There are no (further) constraints on this element Element id Extension.value[x].coding:Reason.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern https://tiplu.de/fhir/maia/CodeSystem/MaiaHiddenReasonCS Mappings v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id Extension.value[x].coding:Reason.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	1..1	code	There are no (further) constraints on this element Element id Extension.value[x].coding:Reason.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	1..1	string	There are no (further) constraints on this element Element id Extension.value[x].coding:Reason.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Extension.value[x].coding:Reason.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	0..1	string	Element id Extension.value[x].text Short description Text representation of the hidden reason. Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Provides a human-readable explanation for the reason the information has to be hidden. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="MaiaHiddenReason" />
    <url value="https://tiplu.de/fhir/maia/StructureDefinition/MaiaHiddenReason" />
    <version value="1.0.0" />
    <name value="MaiaHiddenReason" />
    <title value="Maia Hidden-Reason" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2025-04-30" />
    <publisher value="Tiplu GmbH" />
    <description value="An extension to flag reasons why specific rule-based evaluation has to be hidden or withheld." />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="RiskAssessment" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="Maia Hidden-Reason" />
            <definition value="An extension to flag reasons why specific rule-based evaluation has to be hidden or withheld." />
            <isModifier value="true" />
            <isModifierReason value="The extension modifies the interpretation of the resource by indicating that information has to be intentionally withheld." />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <max value="0" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://tiplu.de/fhir/maia/StructureDefinition/MaiaHiddenReason" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
        </element>
        <element id="Extension.value[x].coding">
            <path value="Extension.value[x].coding" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="$this" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="1" />
        </element>
        <element id="Extension.value[x].coding:Reason">
            <path value="Extension.value[x].coding" />
            <sliceName value="Reason" />
            <short value="Coding representing the reason for hiding the information." />
            <comment value="Specifies a coded reason, from a controlled vocabulary, explaining why the content has to be hidden." />
            <min value="1" />
            <max value="1" />
            <patternCoding>
                <system value="https://tiplu.de/fhir/maia/CodeSystem/MaiaHiddenReasonCS" />
            </patternCoding>
            <binding>
                <strength value="required" />
                <valueSet value="https://tiplu.de/fhir/maia/ValueSet/MaiaHiddenReasonVS" />
            </binding>
        </element>
        <element id="Extension.value[x].coding:Reason.system">
            <path value="Extension.value[x].coding.system" />
            <min value="1" />
        </element>
        <element id="Extension.value[x].coding:Reason.code">
            <path value="Extension.value[x].coding.code" />
            <min value="1" />
        </element>
        <element id="Extension.value[x].coding:Reason.display">
            <path value="Extension.value[x].coding.display" />
            <min value="1" />
        </element>
        <element id="Extension.value[x].text">
            <path value="Extension.value[x].text" />
            <short value="Text representation of the hidden reason." />
            <comment value="Provides a human-readable explanation for the reason the information has to be hidden." />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "MaiaHiddenReason",
    "url": "https://tiplu.de/fhir/maia/StructureDefinition/MaiaHiddenReason",
    "version": "1.0.0",
    "name": "MaiaHiddenReason",
    "title": "Maia Hidden-Reason",
    "status": "draft",
    "experimental": false,
    "date": "2025-04-30",
    "publisher": "Tiplu GmbH",
    "description": "An extension to flag reasons why specific rule-based evaluation has to be hidden or withheld.",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "expression": "RiskAssessment",
            "type": "element"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "Maia Hidden-Reason",
                "definition": "An extension to flag reasons why specific rule-based evaluation has to be hidden or withheld.",
                "isModifier": true,
                "isModifierReason": "The extension modifies the interpretation of the resource by indicating that information has to be intentionally withheld."
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "max": "0"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://tiplu.de/fhir/maia/StructureDefinition/MaiaHiddenReason"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ]
            },
            {
                "id": "Extension.value[x].coding",
                "path": "Extension.value[x].coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "$this"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1
            },
            {
                "id": "Extension.value[x].coding:Reason",
                "path": "Extension.value[x].coding",
                "sliceName": "Reason",
                "short": "Coding representing the reason for hiding the information.",
                "comment": "Specifies a coded reason, from a controlled vocabulary, explaining why the content has to be hidden.",
                "min": 1,
                "max": "1",
                "patternCoding": {
                    "system": "https://tiplu.de/fhir/maia/CodeSystem/MaiaHiddenReasonCS"
                },
                "binding": {
                    "strength": "required",
                    "valueSet": "https://tiplu.de/fhir/maia/ValueSet/MaiaHiddenReasonVS"
                }
            },
            {
                "id": "Extension.value[x].coding:Reason.system",
                "path": "Extension.value[x].coding.system",
                "min": 1
            },
            {
                "id": "Extension.value[x].coding:Reason.code",
                "path": "Extension.value[x].coding.code",
                "min": 1
            },
            {
                "id": "Extension.value[x].coding:Reason.display",
                "path": "Extension.value[x].coding.display",
                "min": 1
            },
            {
                "id": "Extension.value[x].text",
                "path": "Extension.value[x].text",
                "short": "Text representation of the hidden reason.",
                "comment": "Provides a human-readable explanation for the reason the information has to be hidden."
            }
        ]
    }
}

Maia Hidden-Reason