| Package | hl7.fhir.us.ph-library |
| Type | StructureDefinition |
| Id | us-ph-determination-of-reportability-extension |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/ph-library/https://build.fhir.org/ig/HL7/fhir-us-ph-common-library-ig/StructureDefinition-us-ph-determination-of-reportability-extension.html |
| URL | http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension |
| Version | 1.0.0 |
| Status | active |
| Date | 2023-10-04T15:58:18+00:00 |
| Name | USPublicHealthDeterminationOfReportabilityExtension |
| Title | US Public Health Determination of Reportability Extension |
| Realm | us |
| Authority | hl7 |
| Description | This Extension profile represents the determination of reportability. Reportability is "the quality or state of being reportable or not". Reportability does not equate to the patient having a condition or meeting a case definition (definitively being a case). |
| Type | Extension |
| Kind | complex-type |
No resources found
| ValueSet | |
| 2.16.840.1.113883.10.20.15.2.5.3 | Determination of Reportability (eCR) |
Note: links and images are rebased to the (stated) source
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 1..1 | Extension | US Public Health Determination of Reportability Extension | |
  extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension" | |
  value[x] | 1..1 | CodeableConcept | Value representing whether a condition is reportable or not. Binding: Determination of Reportability (eCR) (extensible): Determination of Reportability | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "us-ph-determination-of-reportability-extension",
"meta": {
"versionId": "6",
"lastUpdated": "2023-07-12T07:43:41.009Z"
},
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension",
"version": "1.0.0",
"name": "USPublicHealthDeterminationOfReportabilityExtension",
"title": "US Public Health Determination of Reportability Extension",
"status": "active",
"experimental": false,
"date": "2023-10-04T15:58:18+00:00",
"publisher": "HL7 Public Health Working Group",
"contact": [
{
"name": "HL7 Public Health Working Group",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pher"
},
{
"system": "email",
"value": "pher@lists.HL7.org"
}
]
}
],
"description": "This Extension profile represents the determination of reportability. Reportability is \"the quality or state of being reportable or not\". Reportability does not equate to the patient having a condition or meeting a case definition (definitively being a case).",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Observation"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "US Public Health Determination of Reportability Extension",
"definition": "This extension represents the determination of reportability. Reportability is \"the quality or state of being reportable or not\". Reportability does not equate to the patient having a condition or meeting a case definition (definitively being 'a case').\n\nFor each condition included in the eICR and the relevant public health agency(s), this element indicates the determination of whether the condition is reportable to public health. \n\nThe values that can be used for the Determination of Reportability are described below.\n\nA possible condition is:\n\n- Reportable - The information provided meets reporting criteria for an associated PHA.\n\nA possible condition:\n\n- May be Reportable - The information provided may meet reporting criteria if additional information is provided. The Reportability Response will also be able to share the information needed to definitively determine reportability.\n\nA possible condition is:\n\n- Not Reportable - The information provided conclusively does not meet reporting criteria.\n\nSome decision support systems may not be able to fully differentiate between possible conditions that are Not Reportable and those that May be Reportable if additional information is provided. In these circumstances there may only be a reportability determination of:\n\n- No Reporting Rule Met - The information provided does not meet reporting criteria or may meet reporting criteria if additional information is provided.\n\nThe determination of No Reporting Rule Met may be provided for a possible condition or for all conditions in the eICR.",
"min": 1,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value representing whether a condition is reportable or not.",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "extensible",
"description": "Determination of Reportability",
"valueSet": "http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.113883.10.20.15.2.5.3"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "US Public Health Determination of Reportability Extension",
"definition": "This extension represents the determination of reportability. Reportability is \"the quality or state of being reportable or not\". Reportability does not equate to the patient having a condition or meeting a case definition (definitively being 'a case').\n\nFor each condition included in the eICR and the relevant public health agency(s), this element indicates the determination of whether the condition is reportable to public health. \n\nThe values that can be used for the Determination of Reportability are described below.\n\nA possible condition is:\n\n- Reportable - The information provided meets reporting criteria for an associated PHA.\n\nA possible condition:\n\n- May be Reportable - The information provided may meet reporting criteria if additional information is provided. The Reportability Response will also be able to share the information needed to definitively determine reportability.\n\nA possible condition is:\n\n- Not Reportable - The information provided conclusively does not meet reporting criteria.\n\nSome decision support systems may not be able to fully differentiate between possible conditions that are Not Reportable and those that May be Reportable if additional information is provided. In these circumstances there may only be a reportability determination of:\n\n- No Reporting Rule Met - The information provided does not meet reporting criteria or may meet reporting criteria if additional information is provided.\n\nThe determination of No Reporting Rule Met may be provided for a possible condition or for all conditions in the eICR.",
"min": 1,
"max": "1"
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value representing whether a condition is reportable or not.",
"min": 1,
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "extensible",
"description": "Determination of Reportability",
"valueSet": "http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.113883.10.20.15.2.5.3"
}
}
]
}
}