Release 4B Ballot #1

This page is part of the FHIR Specification (v4.1.0: Release 4B Ballot #1). 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: SOPClass

Security Work Group

Maturity Level: 1

Informative

Use 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 ID AuditEvent.entity

Summary

Name	Flags	Card.	Type	Description & Constraints
SOPClass		0..*	Reference(ImagingStudy)	URL = http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass SOPClass: 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 ID AuditEvent.entity
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass SOPClass: 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 ID AuditEvent.entity
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass"
value[x]	1..1	Reference(ImagingStudy)	Value of extension
Documentation for this format

XML Template

<!-- SOPClass -->

<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

{ // SOPClass
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass", // R! 
    "valueReference" : { Reference(ImagingStudy) } // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
SOPClass		0..*	Reference(ImagingStudy)	URL = http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass SOPClass: 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 ID AuditEvent.entity
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass SOPClass: 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 ID AuditEvent.entity
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass"
value[x]	1..1	Reference(ImagingStudy)	Value of extension
Documentation for this format

XML Template

<!-- SOPClass -->

<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

{ // SOPClass
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass", // R! 
    "valueReference" : { Reference(ImagingStudy) } // C? R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)