{
"description": "This extension applies to the Encounter resource and is used to represent a narrative description of the healthcare event or encounter. The description may include a summary of the issues or problems, management strategies, outcomes or progress, possible prognosis, and the patient’s understanding of the healthcare event. The description may capture text about the encounter that is not captured in other fields.",
"_filename": "StructureDefinition-encounter-description.json",
"package_name": "hl7.fhir.au.base",
"date": "2023-02-24T08:31:37+11:00",
"derivation": "constraint",
"publisher": "HL7 Australia",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "AU",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "EncounterDescription",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"copyright": "HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.",
"type": "Extension",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Encounter Description",
"package_version": "4.1.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}, {
"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.au/fhir/ImplementationGuide/hl7.fhir.au.base"
} ]
}
} ],
"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": "Description, overview or summary of a clinical event and its reasons.",
"isModifier": false,
"short": "Description, overview or summary of an encounter",
"max": "1",
"id": "Extension",
"condition": [ "ele-1" ],
"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.au/fhir/StructureDefinition/encounter-description",
"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": "Encounter description",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Extension.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "28e0275d-7d0c-47e3-996d-36f34a2651fb",
"kind": "complex-type",
"url": "http://hl7.org.au/fhir/StructureDefinition/encounter-description",
"context": [ {
"type": "element",
"expression": "Encounter"
} ],
"version": "4.1.0",
"differential": {
"element": [ {
"id": "Extension",
"max": "1",
"path": "Extension",
"short": "Description, overview or summary of an encounter",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
} ],
"definition": "Description, overview or summary of a clinical event and its reasons."
}, {
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org.au/fhir/StructureDefinition/encounter-description"
}, {
"id": "Extension.value[x]",
"min": 1,
"path": "Extension.value[x]",
"type": [ {
"code": "string"
} ],
"short": "Encounter description"
} ]
},
"contact": [ {
"name": "HL7 Australia Patient Administration Working Group",
"telecom": [ {
"use": "work",
"value": "http://confluence.hl7australia.com/display/PA",
"system": "url"
} ]
}, {
"name": "HL7 Australia Orders and Observations Working Group",
"telecom": [ {
"use": "work",
"value": "https://confluence.hl7australia.com/display/OO",
"system": "url"
} ]
}, {
"name": "HL7 Australia Medications Working Group",
"telecom": [ {
"use": "work",
"value": "https://confluence.hl7australia.com/display/MED",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}