2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: CCDACommentActivity

The official URL for this profile is: 

http://hl7.org/fhir/Profile/observation-ccda-commentactivity-ccdacommentactivity

. C-CDA Comment Activity Observation template to FHIR Profile mapping : C-CDA Comment Activity Observation

This profile was published on Sun, Sep 21, 2014 00:00+1000 as a draft by HL7 International - Orders and Observations WG.

Summary

Required/Prohibited Elements

  • The element Observation is required
  • The element Observation.code is required
  • The element Observation.valueString is required
  • The element Observation.interpretation is prohibited
  • The element Observation.comments is prohibited
  • The element Observation.reliability is prohibited
  • The element Observation.bodySite[x] is prohibited
  • The element Observation.method is prohibited
  • The element Observation.subject is required
  • The element Observation.device is prohibited
  • The element Observation.referenceRange is prohibited

Fixed Values

  • The element Observation.code value must match LOINC code 48767-8("Annotation Comment")

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1
... code 1..1CodeableConceptComment: LOINC 48767-8 = Annotation Comment
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"48767-8","display":"Annotation Comment"}]}
... valueString 1..1
... interpretation 0..0
... comments 0..0
... issued I0..1inv-1: Issued SHALL be present if the provider reference is present
... reliability 0..0
... bodySite[x] 0..0
... method 0..0
... subject 1..1Patient
... performer 0..1
... device 0..0
... referenceRange 0..0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1Measurements and simple assertions
obs-6: Shall only be present if Observation.value[x] is not present
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... code 1..1CodeableConceptComment: LOINC 48767-8 = Annotation Comment
Binding: ObservationType (example, extensible)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"48767-8","display":"Annotation Comment"}]}
... value[x] 1..1Quantity, CodeableConcept, Attachment, Ratio, dateTime, Period, SampledData, string, timeActual result
... dataAbsentReason I0..1codeunknown | asked | temp | notasked +
Binding: DataAbsentReason (required, not extensible)
Example: unknown
... applies[x] 0..1dateTime, PeriodPhysiologically Relevant time/time-period for observation
... issued I0..1instantDate/Time this was made available
inv-1: Issued SHALL be present if the provider reference is present
... status M1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required, not extensible)
... identifier 0..1IdentifierUnique Id for this particular observation
... subject 1..1PatientWho and/or what this is about
... specimen 0..1SpecimenSpecimen used for this observation
... performer 0..1Practitioner, Organization, Patient, RelatedPersonWho did the observation
... encounter 0..1EncounterHealthcare event during which this observation is made
... related 0..*Observations related to this observation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required, not extensible)
.... target 1..1ObservationObservation that is related to this one

XML Template

JSON Template

todo

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1
... code 1..1CodeableConceptComment: LOINC 48767-8 = Annotation Comment
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"48767-8","display":"Annotation Comment"}]}
... valueString 1..1
... interpretation 0..0
... comments 0..0
... issued I0..1inv-1: Issued SHALL be present if the provider reference is present
... reliability 0..0
... bodySite[x] 0..0
... method 0..0
... subject 1..1Patient
... performer 0..1
... device 0..0
... referenceRange 0..0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1Measurements and simple assertions
obs-6: Shall only be present if Observation.value[x] is not present
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... code 1..1CodeableConceptComment: LOINC 48767-8 = Annotation Comment
Binding: ObservationType (example, extensible)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"48767-8","display":"Annotation Comment"}]}
... value[x] 1..1Quantity, CodeableConcept, Attachment, Ratio, dateTime, Period, SampledData, string, timeActual result
... dataAbsentReason I0..1codeunknown | asked | temp | notasked +
Binding: DataAbsentReason (required, not extensible)
Example: unknown
... applies[x] 0..1dateTime, PeriodPhysiologically Relevant time/time-period for observation
... issued I0..1instantDate/Time this was made available
inv-1: Issued SHALL be present if the provider reference is present
... status M1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required, not extensible)
... identifier 0..1IdentifierUnique Id for this particular observation
... subject 1..1PatientWho and/or what this is about
... specimen 0..1SpecimenSpecimen used for this observation
... performer 0..1Practitioner, Organization, Patient, RelatedPersonWho did the observation
... encounter 0..1EncounterHealthcare event during which this observation is made
... related 0..*Observations related to this observation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required, not extensible)
.... target 1..1ObservationObservation that is related to this one

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Observation.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Observation.codeObservationTypeexample (extensible)LOINC Codes
Observation.dataAbsentReasonDataAbsentReasonrequiredDataAbsentReason
Observation.interpretationObservationInterpretationpreferred (extensible)Observation Interpretation Codes
Observation.statusObservationStatusrequiredObservationStatus
Observation.reliabilityObservationReliabilityrequiredObservationReliability
Observation.bodySite[x]BodySiteexample (extensible)SNOMED CT Body Structures
Observation.methodObservationMethodexample (extensible)Observation Methods
Observation.referenceRange.meaningObservationRangeMeaningexample (extensible)Observation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType

Constraints

IdPathNameDetails
obs-6Observationdata absent reasonShall only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
inv-1Observation.issuedIssued SHALL be present if the provider reference is present
XPath: not(exists(f:performer)) or exists(f:issued)
obs-3Observation.referenceRangereference rangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
obs-4Observation.referenceRange.lowlow range comparatorsLow range comparators can only be '>' or '>=' or empty
XPath: not(exists(f:comparator)) or boolean(f:comparator/@value = '<') or boolean(f:comparator/@value = '<=')
obs-5Observation.referenceRange.highhigh range comparatorsHigh range comparators can only be '<' or '<=' or empty
XPath: not(exists(f:comparator)) or boolean(f:comparator/@value = '>') or boolean(f:comparator/@value = '>=')
.