{
"description": "This email address is associated with a [\\\"Direct Secure Messaging\\\"](https://directtrust.org/what-we-do/direct-secure-messaging) service. This extension can only be used on contact points where the system = 'email'",
"_filename": "StructureDefinition-us-core-direct.json",
"package_name": "hl7.fhir.us.core.r4",
"date": "2022-11-16",
"derivation": "constraint",
"publisher": "HL7 International / Cross-Group Projects",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "USCoreDirectEmailExtension",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License",
"type": "Extension",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "US Core Direct email Extension",
"package_version": "7.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cgp"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3,
"_valueInteger": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core"
} ]
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core"
} ]
}
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension",
"min": 0,
"definition": "This email address is associated with a \"Direct Secure Messaging\" service. This extension can only be used on contact points where the system = 'email'",
"isModifier": false,
"short": "Email is a \"Direct\" email",
"mapping": [ {
"map": "No v2 equivalent",
"identity": "v2"
}, {
"map": "No RIM equivalent",
"identity": "rim"
} ],
"max": "1",
"id": "Extension",
"condition": [ "ele-1" ],
"comment": "This extension can only be used on contact points where the system = 'email'.",
"base": {
"max": "*",
"min": 0,
"path": "Extension"
}
}, {
"path": "Extension.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Extension.value[x]",
"min": 1,
"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).",
"isModifier": false,
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Extension.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
} ]
},
"status": "active",
"id": "a2188fdb-8205-4b18-a360-53933c7daaa8",
"kind": "complex-type",
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.40.2.42.19",
"system": "urn:ietf:rfc:3986"
} ],
"context": [ {
"type": "element",
"expression": "ContactPoint"
} ],
"version": "7.0.0",
"differential": {
"element": [ {
"path": "Extension",
"min": 0,
"definition": "This email address is associated with a \"Direct Secure Messaging\" service. This extension can only be used on contact points where the system = 'email'",
"isModifier": false,
"short": "Email is a \"Direct\" email",
"mapping": [ {
"map": "No v2 equivalent",
"identity": "v2"
}, {
"map": "No RIM equivalent",
"identity": "rim"
} ],
"max": "1",
"id": "Extension",
"comment": "This extension can only be used on contact points where the system = 'email'."
}, {
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct"
}, {
"id": "Extension.value[x]",
"max": "1",
"min": 1,
"path": "Extension.value[x]",
"type": [ {
"code": "boolean"
} ]
} ]
},
"contact": [ {
"name": "HL7 International / Cross-Group Projects",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/cgp",
"system": "url"
}, {
"value": "cgp@lists.HL7.org",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}