FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/ee-tis-annotation

Packageig-ee-medication-scheme
TypeStructureDefinition
Idee-tis-annotation
FHIR VersionR5
Sourcehttps://fhir.ee/https://build.fhir.org/ig/TEHIK-EE/ig-ee-medication-scheme/StructureDefinition-ee-tis-annotation.html
URLhttps://fhir.ee/StructureDefinition/ee-tis-annotation
Version1.0.0
Statusdraft
Date2024-01-31T13:55:03.1985103+00:00
NameEETISAnnotation
Realmee
DescriptionKommentaar/märkus. Note or comment with time and author.
TypeAnnotation
Kindcomplex-type

Resources that use this resource

StructureDefinition
ee-tis-communicationEETISCommunication
ee-tis-medication-listEETISMedicationList

Resources that this resource uses

StructureDefinition
ee-tis-practitioner-roleEETISPractitionerRole
ee-tis-practitionerEETISPractitioner
ee-organizationEEBase Organization

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition ee-tis-annotation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Annotation 0..*AnnotationNote/comment
... Slices for author[x] 0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization), stringHealthcare professional who added comment. Use string to express the name and role of HCP
Slice: Unordered, Open by type:$this
.... author[x]:authorReference 0..1Reference(EETISPractitioner | EETISPractitionerRole | EEBase Organization)Individual responsible for the annotation
.... author[x]:authorString 0..1stringIndividual responsible for the annotation
... time 0..1dateTimeTime when the comment was added.
... text 1..1markdownComment about medication scheme

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "ee-tis-annotation",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "has-size"
    }
  ],
  "url": "https://fhir.ee/StructureDefinition/ee-tis-annotation",
  "version": "1.0.0",
  "name": "EETISAnnotation",
  "status": "draft",
  "date": "2024-01-31T13:55:03.1985103+00:00",
  "publisher": "TEHIK",
  "contact": [
    {
      "name": "TEHIK",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.tehik.ee"
        },
        {
          "system": "email",
          "value": "fhir@tehik.ee"
        }
      ]
    },
    {
      "name": "TEHIK Andmekorraldus",
      "telecom": [
        {
          "system": "email",
          "value": "andmekorraldus@tehik.ee",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Kommentaar/märkus. Note or comment with time and author.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "EE",
          "display": "Estonia"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 V2 Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "type": "Annotation",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Annotation",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "Annotation",
        "path": "Annotation",
        "short": "Note/comment",
        "definition": "Kommentaar/märkus.Kommentaar terve ravimiskeemi kohta. Erineb ravimiskeemi üksiku rea kommentaarist, vt. Communication-profiili.",
        "comment": "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time.  This element may need to be included in narrative because of the potential for modifying information.  *Annotations SHOULD NOT* be used to communicate \"modifying\" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Annotation",
          "min": 0,
          "max": "*"
        },
        "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"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a,Act"
          },
          {
            "identity": "v2",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Annotation.id",
        "path": "Annotation.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": "Annotation.extension",
        "path": "Annotation.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": "Annotation.author[x]",
        "path": "Annotation.author[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "ordered": false,
          "rules": "closed"
        },
        "short": "Healthcare professional who added comment. Use string to express the name and role of HCP",
        "definition": "The individual responsible for making the annotation.",
        "comment": "Organization is used when there's no need for specific attribution as to who made the comment.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Annotation.author[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          },
          {
            "code": "string"
          }
        ],
        "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"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "Act.participant[typeCode=AUT].role"
          }
        ]
      },
      {
        "id": "Annotation.author[x]:authorReference",
        "path": "Annotation.author[x]",
        "sliceName": "authorReference",
        "short": "Individual responsible for the annotation",
        "definition": "The individual responsible for making the annotation.",
        "comment": "Organization is used when there's no need for specific attribution as to who made the comment.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Annotation.author[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.ee/StructureDefinition/ee-tis-practitioner",
              "https://fhir.ee/StructureDefinition/ee-tis-practitioner-role",
              "https://fhir.ee/base/StructureDefinition/ee-organization"
            ]
          }
        ],
        "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"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "Act.participant[typeCode=AUT].role"
          }
        ]
      },
      {
        "id": "Annotation.author[x]:authorString",
        "path": "Annotation.author[x]",
        "sliceName": "authorString",
        "short": "Individual responsible for the annotation",
        "definition": "The individual responsible for making the annotation.",
        "comment": "Organization is used when there's no need for specific attribution as to who made the comment.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Annotation.author[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "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"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "Act.participant[typeCode=AUT].role"
          }
        ]
      },
      {
        "id": "Annotation.time",
        "path": "Annotation.time",
        "short": "Time when the comment was added.",
        "definition": "Kommentaari lisamise aeg",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Annotation.time",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "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"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "Act.effectiveTime"
          }
        ]
      },
      {
        "id": "Annotation.text",
        "path": "Annotation.text",
        "short": "Comment about medication scheme",
        "definition": "Kommentaari sisu",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Annotation.text",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "markdown"
          }
        ],
        "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"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "Act.text"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Annotation",
        "path": "Annotation",
        "short": "Note/comment",
        "definition": "Kommentaar/märkus.Kommentaar terve ravimiskeemi kohta. Erineb ravimiskeemi üksiku rea kommentaarist, vt. Communication-profiili."
      },
      {
        "id": "Annotation.author[x]",
        "path": "Annotation.author[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "ordered": false,
          "rules": "open"
        },
        "short": "Healthcare professional who added comment. Use string to express the name and role of HCP"
      },
      {
        "id": "Annotation.author[x]:authorReference",
        "path": "Annotation.author[x]",
        "sliceName": "authorReference",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.ee/StructureDefinition/ee-tis-practitioner",
              "https://fhir.ee/StructureDefinition/ee-tis-practitioner-role",
              "https://fhir.ee/base/StructureDefinition/ee-organization"
            ]
          }
        ]
      },
      {
        "id": "Annotation.author[x]:authorString",
        "path": "Annotation.author[x]",
        "sliceName": "authorString",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Annotation.time",
        "path": "Annotation.time",
        "short": "Time when the comment was added.",
        "definition": "Kommentaari lisamise aeg"
      },
      {
        "id": "Annotation.text",
        "path": "Annotation.text",
        "short": "Comment about medication scheme",
        "definition": "Kommentaari sisu"
      }
    ]
  }
}