FHIR IG analytics| Package | obligation |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-Obligation1Definition.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/frankoemig/obligation/StructureDefinition-Obligation1Definition.html |
| URL | http://v2.hl7.org/fhir/StructureDefinition/Obligation1Definition |
| Version | 0.1.0 |
| Status | draft |
| Date | 2023-10-10T18:09:04+02:00 |
| Name | Obligation1Definition |
| Title | Obligation1Definition |
| Description | Obligation 1 Definition Description: is to be placed behind the actor: profile 0..* <- 1 actor 0..* <-> 0..* obligation |
| Type | http://v2.hl7.org/fhir/Obligation |
| Kind | logical |
| StructureDefinition | ||
| obligation#current | Obligation1Definition | Obligation1Definition |
| StructureDefinition | ||
| obligation#current | Obligation1Definition | Obligation1Definition |
| ValueSet | ||
| obligation#current | dataExpectation | Data Expectation ValueSet |
| obligation#current | obligationAlone | Obligation Alone ValueSet |
| obligation#current | verb | Verb ValueSet |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition Obligation1Definition
Last updated: 2023-08-09 18:09:04+0200
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Obligation | 0..* | Base | Obligation1Definition Instances of this logical model can be the target of a Reference | |
  url | 0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
 identifier | 0..* | Identifier | Additional identifier for the obligation (business identifier) | |
| version | 0..1 | string | Business version of the obligation | |
| name | 0..1 | string | Short Name for this Obligation | |
| status | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
| date | 0..1 | dateTime | Date last changed | |
| documentation | 0..1 | markdown | Documentation of the purpose or application of the obligation | |
| usage | 0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
 actor | 0..* | Reference(DomainResource) | Actor(s) to whom this obligation applies to (if any) | |
| element | 0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
| including | 0..* | Reference(Obligation1Definition) | Other obligations that are implicitly to be included | |
 activity | 0..* | BackboneElement | set of obligations | |
 verb | 0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
| obligation | 0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
| dataExpectation | 0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "Obligation1Definition",
"meta": {
"lastUpdated": "2023-08-09T18:09:04.256+02:00"
},
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "inm"
}
],
"url": "http://v2.hl7.org/fhir/StructureDefinition/Obligation1Definition",
"version": "0.1.0",
"name": "Obligation1Definition",
"title": "Obligation1Definition",
"status": "draft",
"experimental": true,
"date": "2023-10-10T18:09:04+02:00",
"description": "Obligation 1 Definition Description:\n\nis to be placed behind the actor: profile 0..* <- 1 actor 0..* <-> 0..* obligation",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://v2.hl7.org/fhir/Obligation",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "Obligation",
"path": "Obligation",
"short": "Obligation1Definition",
"definition": "Obligation 1 Definition Resource",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Obligation.url",
"path": "Obligation.url",
"short": "Canonical identifier for this obligation, represented as a URI (globally unique)",
"definition": "Canonical identifier for this obligation, represented as a URI (globally unique)",
"min": 0,
"max": "1",
"base": {
"path": "Obligation.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "Obligation.identifier",
"path": "Obligation.identifier",
"short": "Additional identifier for the obligation (business identifier)",
"definition": "Additional identifier for the obligation (business identifier)",
"min": 0,
"max": "*",
"base": {
"path": "Obligation.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "Obligation.version",
"path": "Obligation.version",
"short": "Business version of the obligation",
"definition": "Business version of the obligation",
"min": 0,
"max": "1",
"base": {
"path": "Obligation.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Obligation.name",
"path": "Obligation.name",
"short": "Short Name for this Obligation",
"definition": "Name for this obligation definition (computer friendly)",
"min": 0,
"max": "1",
"base": {
"path": "Obligation.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Obligation.status",
"path": "Obligation.status",
"short": "draft | active | retired | unknown",
"definition": "draft | active | retired | unknown",
"min": 1,
"max": "1",
"base": {
"path": "Obligation.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
{
"id": "Obligation.date",
"path": "Obligation.date",
"short": "Date last changed",
"definition": "Date last changed",
"min": 0,
"max": "1",
"base": {
"path": "Obligation.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "Obligation.documentation",
"path": "Obligation.documentation",
"short": "Documentation of the purpose or application of the obligation",
"definition": "Documentation of the purpose or application of the obligation",
"min": 0,
"max": "1",
"base": {
"path": "Obligation.documentation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
]
},
{
"id": "Obligation.usage",
"path": "Obligation.usage",
"short": "Qualifies the usage - jurisdiction, gender, workflow status etc",
"definition": "Qualifies the usage - jurisdiction, gender, workflow status etc",
"min": 0,
"max": "*",
"base": {
"path": "Obligation.usage",
"min": 0,
"max": "*"
},
"type": [
{
"code": "UsageContext"
}
]
},
{
"id": "Obligation.actor",
"path": "Obligation.actor",
"short": "Actor(s) to whom this obligation applies to (if any)",
"definition": "Actor(s) to whom this obligation applies to (if any)",
"min": 0,
"max": "*",
"base": {
"path": "Obligation.actor",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/DomainResource"
]
}
]
},
{
"id": "Obligation.element",
"path": "Obligation.element",
"short": "Profile element(s) to whom this obligation applies to",
"definition": "Profile element(s) to whom this obligation applies to",
"min": 0,
"max": "*",
"base": {
"path": "Obligation.element",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
]
},
{
"id": "Obligation.including",
"path": "Obligation.including",
"short": "Other obligations that are implicitly to be included",
"definition": "Other obligations that are implicitly to be included",
"min": 0,
"max": "*",
"base": {
"path": "Obligation.including",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://v2.hl7.org/fhir/StructureDefinition/Obligation1Definition"
]
}
]
},
{
"id": "Obligation.activity",
"path": "Obligation.activity",
"short": "set of obligations",
"definition": "set of obligations",
"min": 0,
"max": "*",
"base": {
"path": "Obligation.activity",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "Obligation.activity.id",
"path": "Obligation.activity.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": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Obligation.activity.extension",
"path": "Obligation.activity.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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 managable, 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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"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())",
"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()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Obligation.activity.modifierExtension",
"path": "Obligation.activity.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"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())",
"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()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Obligation.activity.verb",
"path": "Obligation.activity.verb",
"short": "Composite code describing the requirement level of the obligation",
"definition": "Composite code describing the requirement level of the obligation",
"min": 0,
"max": "1",
"base": {
"path": "Obligation.activity.verb",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"valueSet": "http://v2.hl7.org/fhir/ValueSet/verb"
}
},
{
"id": "Obligation.activity.obligation",
"path": "Obligation.activity.obligation",
"short": "Composite code describing the activity/obligation to performed by the application",
"definition": "Composite code describing the activity/obligation to performed by the application",
"min": 0,
"max": "1",
"base": {
"path": "Obligation.activity.obligation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://v2.hl7.org/fhir/ValueSet/obligationAlone"
}
},
{
"id": "Obligation.activity.dataExpectation",
"path": "Obligation.activity.dataExpectation",
"short": "Composite code describing the expacation about data appearance",
"definition": "Composite code describing the expacation about data appearance",
"min": 0,
"max": "1",
"base": {
"path": "Obligation.activity.dataExpectation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"valueSet": "http://v2.hl7.org/fhir/ValueSet/dataExpectation"
}
}
]
},
"differential": {
"element": [
{
"id": "Obligation",
"path": "Obligation",
"short": "Obligation1Definition",
"definition": "Obligation 1 Definition Resource"
},
{
"id": "Obligation.url",
"path": "Obligation.url",
"short": "Canonical identifier for this obligation, represented as a URI (globally unique)",
"definition": "Canonical identifier for this obligation, represented as a URI (globally unique)",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "Obligation.identifier",
"path": "Obligation.identifier",
"short": "Additional identifier for the obligation (business identifier)",
"definition": "Additional identifier for the obligation (business identifier)",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "Obligation.version",
"path": "Obligation.version",
"short": "Business version of the obligation",
"definition": "Business version of the obligation",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Obligation.name",
"path": "Obligation.name",
"short": "Short Name for this Obligation",
"definition": "Name for this obligation definition (computer friendly)",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Obligation.status",
"path": "Obligation.status",
"short": "draft | active | retired | unknown",
"definition": "draft | active | retired | unknown",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
{
"id": "Obligation.date",
"path": "Obligation.date",
"short": "Date last changed",
"definition": "Date last changed",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "Obligation.documentation",
"path": "Obligation.documentation",
"short": "Documentation of the purpose or application of the obligation",
"definition": "Documentation of the purpose or application of the obligation",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "Obligation.usage",
"path": "Obligation.usage",
"short": "Qualifies the usage - jurisdiction, gender, workflow status etc",
"definition": "Qualifies the usage - jurisdiction, gender, workflow status etc",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
]
},
{
"id": "Obligation.actor",
"path": "Obligation.actor",
"short": "Actor(s) to whom this obligation applies to (if any)",
"definition": "Actor(s) to whom this obligation applies to (if any)",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/DomainResource"
]
}
]
},
{
"id": "Obligation.element",
"path": "Obligation.element",
"short": "Profile element(s) to whom this obligation applies to",
"definition": "Profile element(s) to whom this obligation applies to",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
]
},
{
"id": "Obligation.including",
"path": "Obligation.including",
"short": "Other obligations that are implicitly to be included",
"definition": "Other obligations that are implicitly to be included",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://v2.hl7.org/fhir/StructureDefinition/Obligation1Definition"
]
}
]
},
{
"id": "Obligation.activity",
"path": "Obligation.activity",
"short": "set of obligations",
"definition": "set of obligations",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "Obligation.activity.verb",
"path": "Obligation.activity.verb",
"short": "Composite code describing the requirement level of the obligation",
"definition": "Composite code describing the requirement level of the obligation",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"valueSet": "http://v2.hl7.org/fhir/ValueSet/verb"
}
},
{
"id": "Obligation.activity.obligation",
"path": "Obligation.activity.obligation",
"short": "Composite code describing the activity/obligation to performed by the application",
"definition": "Composite code describing the activity/obligation to performed by the application",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://v2.hl7.org/fhir/ValueSet/obligationAlone"
}
},
{
"id": "Obligation.activity.dataExpectation",
"path": "Obligation.activity.dataExpectation",
"short": "Composite code describing the expacation about data appearance",
"definition": "Composite code describing the expacation about data appearance",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"valueSet": "http://v2.hl7.org/fhir/ValueSet/dataExpectation"
}
}
]
}
}