STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.37.11.9 StructureDefinition: XDSDocumentManifest

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/xdsdocumentmanifest

SubmissionSet

This profile was published on Sun, Jun 24, 2012 00:00+1000 as a draft by HL7.

2.37.11.9.1 Formal Views of Profile Content

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

This structure is derived from DocumentManifest.

Summary

Mandatory: 2 elements

This structure is derived from DocumentManifest.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest 0..*SubmissionSet
... masterIdentifier 1..1IdentifierSubmissionSet.uniqueId
... subject 0..1Reference(Patient)SubmissionSet.patientId
... recipient 0..*Reference(Patient | Practitioner | Organization)SubmissionSet.intendedRecipient 
... type 0..1CodeableConceptSubmissionSet.contentTypeCode
... author 1..*Reference(Practitioner | Device)SubmissionSet.author
... created 0..1dateTimeSubmissionSet.submissionTime
... source 0..1uriSubmissionSet.sourceId
... status 1..1codeSubmissionSet.availabilityStatus
Binding: DocumentReferenceStatus (required)
... description 0..1stringSubmissionSet.title
... content 1..*BackboneElementSubmissionSet.documentEntry

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest I0..*SubmissionSet
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (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
... masterIdentifier ∑1..1IdentifierSubmissionSet.uniqueId
... identifier ∑0..*IdentifierOther identifiers for the manifest
... subject ∑0..1Reference(Patient)SubmissionSet.patientId
... recipient ∑0..*Reference(Patient | Practitioner | Organization)SubmissionSet.intendedRecipient 
... type ∑0..1CodeableConceptSubmissionSet.contentTypeCode
Binding: Document Type Value Set (preferred)
... author ∑1..*Reference(Practitioner | Device)SubmissionSet.author
... created ∑0..1dateTimeSubmissionSet.submissionTime
... source ∑0..1uriSubmissionSet.sourceId
... status ?!∑1..1codeSubmissionSet.availabilityStatus
Binding: DocumentReferenceStatus (required)
... description ∑0..1stringSubmissionSet.title
... content ∑1..*BackboneElementSubmissionSet.documentEntry
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... p[x] ∑1..1Attachment, Reference(Resource)Contents of this set of documents
... related ∑0..*BackboneElementRelated things
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... identifier ∑0..1IdentifierIdentifiers of things that are related
.... ref ∑0..1Reference(Resource)Related Resource

doco Documentation for this format

todo

This structure is derived from DocumentManifest.

Summary

Mandatory: 2 elements

Differential View

This structure is derived from DocumentManifest.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest 0..*SubmissionSet
... masterIdentifier 1..1IdentifierSubmissionSet.uniqueId
... subject 0..1Reference(Patient)SubmissionSet.patientId
... recipient 0..*Reference(Patient | Practitioner | Organization)SubmissionSet.intendedRecipient 
... type 0..1CodeableConceptSubmissionSet.contentTypeCode
... author 1..*Reference(Practitioner | Device)SubmissionSet.author
... created 0..1dateTimeSubmissionSet.submissionTime
... source 0..1uriSubmissionSet.sourceId
... status 1..1codeSubmissionSet.availabilityStatus
Binding: DocumentReferenceStatus (required)
... description 0..1stringSubmissionSet.title
... content 1..*BackboneElementSubmissionSet.documentEntry

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest I0..*SubmissionSet
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (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
... masterIdentifier ∑1..1IdentifierSubmissionSet.uniqueId
... identifier ∑0..*IdentifierOther identifiers for the manifest
... subject ∑0..1Reference(Patient)SubmissionSet.patientId
... recipient ∑0..*Reference(Patient | Practitioner | Organization)SubmissionSet.intendedRecipient 
... type ∑0..1CodeableConceptSubmissionSet.contentTypeCode
Binding: Document Type Value Set (preferred)
... author ∑1..*Reference(Practitioner | Device)SubmissionSet.author
... created ∑0..1dateTimeSubmissionSet.submissionTime
... source ∑0..1uriSubmissionSet.sourceId
... status ?!∑1..1codeSubmissionSet.availabilityStatus
Binding: DocumentReferenceStatus (required)
... description ∑0..1stringSubmissionSet.title
... content ∑1..*BackboneElementSubmissionSet.documentEntry
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... p[x] ∑1..1Attachment, Reference(Resource)Contents of this set of documents
... related ∑0..*BackboneElementRelated things
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... identifier ∑0..1IdentifierIdentifiers of things that are related
.... ref ∑0..1Reference(Resource)Related Resource

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

2.37.11.9.2 Terminology Bindings

PathNameConformanceValueSet
DocumentManifest.languageCommon LanguagesextensibleCommon Languages
DocumentManifest.typeDocument Type Value SetpreferredDocument Type Value Set
DocumentManifest.statusDocumentReferenceStatusrequiredDocumentReferenceStatus

2.37.11.9.3 Constraints

IdPathDetailsRequirements
dom-2DocumentManifestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1DocumentManifestIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4DocumentManifestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3DocumentManifestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
.