STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 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 . Page versions: R4B R4 R3

Extension: UIDs of SOP classes referred to

(No assigned work group)   Maturity Level : 0 Context: Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass

Status: draft. Extension maintained by: Health Level Seven, Inc. - Security WG

Required if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") and any of the optional fields (AccessionNumber, ContainsMPPS, NumberOfInstances, ContainsSOPInstances,Encrypted,Anonymized) are present in this Participant Object. May be present if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") even though none of the optional fields are present.

Context of Use: Use on element: AuditEvent.entity

usage info: insert a list of places where this extension is used

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Reference ( ImagingStudy ) URL = http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass
UIDs of SOP classes referred to: Required if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") and any of the optional fields (AccessionNumber, ContainsMPPS, NumberOfInstances, ContainsSOPInstances,Encrypted,Anonymized) are present in this Participant Object. May be present if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") even though none of the optional fields are present.
Use on element: AuditEvent.entity

doco Documentation for this format

Fulle Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass
UIDs of SOP classes referred to: Required if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") and any of the optional fields (AccessionNumber, ContainsMPPS, NumberOfInstances, ContainsSOPInstances,Encrypted,Anonymized) are present in this Participant Object. May be present if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") even though none of the optional fields are present.
Use on element: AuditEvent.entity
. . . extension 0 .. 0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass"
. . . valueReference 1..1 Reference ( ImagingStudy ) Value of extension

doco Documentation for this format

XML Template 

<!-- UIDs of SOP classes referred to -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass" >
  <!-- from Element: extension -->
 <valueReference><!-- 1..1 Reference(ImagingStudy) Value of extension --></valueReference>
</extension>

JSON Template 

{ // UIDs of SOP classes referred to
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass", // R! 
    "valueReference" : { Reference(ImagingStudy) } // R! Value of extension
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Reference ( ImagingStudy ) URL = http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass
UIDs of SOP classes referred to: Required if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") and any of the optional fields (AccessionNumber, ContainsMPPS, NumberOfInstances, ContainsSOPInstances,Encrypted,Anonymized) are present in this Participant Object. May be present if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") even though none of the optional fields are present.
Use on element: AuditEvent.entity

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass
UIDs of SOP classes referred to: Required if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") and any of the optional fields (AccessionNumber, ContainsMPPS, NumberOfInstances, ContainsSOPInstances,Encrypted,Anonymized) are present in this Participant Object. May be present if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") even though none of the optional fields are present.
Use on element: AuditEvent.entity
. . . extension 0 .. 0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass"
. . . valueReference 1..1 Reference ( ImagingStudy ) Value of extension

doco Documentation for this format

XML Template 

<!-- UIDs of SOP classes referred to -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass" >
  <!-- from Element: extension -->
 <valueReference><!-- 1..1 Reference(ImagingStudy) Value of extension --></valueReference>
</extension>

JSON Template 

{ // UIDs of SOP classes referred to
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass", // R! 
    "valueReference" : { Reference(ImagingStudy) } // R! Value of extension
  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children (xpath: @value|f:*|h:div )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) )