FHIR IG analytics
| Package | hl7.fhir.us.ndh.r4b |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-base-ext-usage-restriction.json |
| FHIR Version | R4B |
| Source | http://hl7.org/fhir/us/ndh/STU1/StructureDefinition-base-ext-usage-restriction.html |
| URL | http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction |
| Version | 1.0.0 |
| Status | active |
| Date | 2017-10-20T10:59:36.931+11:00 |
| Name | UsageRestriction |
| Title | NDH Usage Restriction |
| Realm | us |
| Authority | hl7 |
| Description | The FHIR specification contains a security meta tag which can be used to inform systems of the sensitivity of resources, as well as by access control
mechanisms to ensure content isn't exposed that shouldn't be. This mechanism only goes to the resource level, this reference to a usage-restriction (consent) extends
this further into the resource, and can be applied to any element, and may apply to all properties beneath the element (e.g. If applied to an identifier on a practitioner,
then all the properties of the identifier should not be exposed unless it is understood) This will be expected to be used as a modifier extension. |
| Type | Extension |
| Kind | complex-type |
Resources that use this resource
Resources that this resource uses
Examples of Use for Extension
Narrative
Note: links and images are rebased to the (stated) source
Source1
{
"resourceType": "StructureDefinition",
"id": "base-ext-usage-restriction",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pa"
},
{
"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/ndh/ImplementationGuide/hl7.fhir.us.ndh"
}
]
}
}
],
"url": "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction",
"version": "1.0.0",
"name": "UsageRestriction",
"title": "NDH Usage Restriction",
"status": "active",
"date": "2017-10-20T10:59:36.931+11:00",
"publisher": "HL7 International / Patient Administration",
"contact": [
{
"name": "HL7 International / Patient Administration",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm"
},
{
"system": "email",
"value": "pafm@lists.hl7.org"
}
]
}
],
"description": "The FHIR specification contains a security meta tag which can be used to inform systems of the sensitivity of resources, as well as by access control \nmechanisms to ensure content isn't exposed that shouldn't be. This mechanism only goes to the resource level, this reference to a usage-restriction (consent) extends \nthis further into the resource, and can be applied to any element, and may apply to all properties beneath the element (e.g. If applied to an identifier on a practitioner, \nthen all the properties of the identifier should not be exposed unless it is understood) This will be expected to be used as a modifier extension.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America"
}
]
}
],
"fhirVersion": "4.3.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "CareTeam"
},
{
"type": "element",
"expression": "Endpoint"
},
{
"type": "element",
"expression": "HealthcareService"
},
{
"type": "element",
"expression": "InsurancePlan"
},
{
"type": "element",
"expression": "Location"
},
{
"type": "element",
"expression": "Organization"
},
{
"type": "element",
"expression": "OrganizationAffiliation"
},
{
"type": "element",
"expression": "Practitioner"
},
{
"type": "element",
"expression": "PractitionerRole"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Restriction",
"definition": "Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared \nunder particular condition, such as a signed data use agreement between parties",
"min": 0,
"max": "*",
"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/ndh/StructureDefinition/base-ext-usage-restriction",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Reference",
"definition": "Reference to the restriction resource (consent)",
"comment": "This is anticipated to usually be a reference to a contained resource (this eases distribution, and permits the same consent applying \nto multiple properties in the same resource)",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Restriction"
],
"aggregation": [
"contained"
]
}
],
"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,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Restriction",
"definition": "Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared \nunder particular condition, such as a signed data use agreement between parties"
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Reference",
"definition": "Reference to the restriction resource (consent)",
"comment": "This is anticipated to usually be a reference to a contained resource (this eases distribution, and permits the same consent applying \nto multiple properties in the same resource)",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Restriction"
],
"aggregation": [
"contained"
]
}
]
}
]
}
}
Extension 
extension 
value[x] 
FHIR
FHIRsmith