APIX Regulatory DocumentReference - Regulatory Workflows and Interactions

Regulatory Workflows and Interactions - pharma, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/APIX---API-Exchange-for-Medicinal-Products/ and changes regularly. See the Directory of published versions

Resource Profile: APIX Regulatory DocumentReference

Official URL: http://hl7.org/fhir/uv/apix/StructureDefinition/apix-documentreference				Version: 0.1.0	Highlight text changes?
Standards status: Trial-use				Maturity Level: 1	Computable Name: APIXDocumentReference

DocumentReference profile used in APIX regulatory submissions. Supports both embedded base64 data and referenced binaries via URL (Index Pattern). Includes support for versioning, lifecycle status, and CTD section categorization.

Usages:

Examples for this Profile: DocumentReference/docref-approval-letter, DocumentReference/docref-assessment-report, DocumentReference/docref-cta-application-form, DocumentReference/docref-cta-cover-letter...

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
DocumentReference	C	0..*	DocumentReference	A reference to a document Constraints: docRef-1, docRef-2
DocumentReference.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
DocumentReference.contained		0..*	Resource	Contained, inline Resources
DocumentReference.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.Slices for identifier	This element must be supported. This element is included in summaries.	2..2	Identifier	Document Set Identifier and Document Version Identifier Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:docSetIdentifier	This element must be supported. This element is included in summaries. C	1..1	Identifier	Document Set Identifier Constraints: identifier-is-a-uuid
DocumentReference.Slices for identifier.identifier:docSetIdentifier.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DocumentReference.Slices for identifier.identifier:docSetIdentifier.type	This element is included in summaries.	1..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo", "code" : "docsetid", "display" : "Document Set Identifier" } ] }`
DocumentReference.Slices for identifier.identifier:docSetIdentifier.system	This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
DocumentReference.Slices for identifier.identifier:docSetIdentifier.value	This element is included in summaries. C	1..1	string	The value that is unique Example General: 123456
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier	This element must be supported. This element is included in summaries. C	1..1	Identifier	Document Version Number Identifier Constraints: identifier-is-a-uuid
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.type	This element is included in summaries.	1..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo", "code" : "docverid", "display" : "Document Version Number Identifier" } ] }`
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.system	This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.value	This element is included in summaries. C	1..1	string	The value that is unique Example General: 123456
DocumentReference.version	This element must be supported. This element is included in summaries.	0..1	string	Business version of the document (e.g. 1.0, 2.1)
DocumentReference.status	This element is a modifier element. This element is included in summaries.	1..1	code	current \| superseded \| entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
DocumentReference.docStatus	This element must be supported. This element is included in summaries.	0..1	code	preliminary \| final \| amended \| appended Binding: CompositionStatus (required): Status of the underlying document.
DocumentReference.type	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	CTD section code (e.g. 3.2.S.1.1) Binding: Value Set APIX CTD/eCTD Section Code System (example): Precise type of clinical document.
DocumentReference.category	This element must be supported. This element is included in summaries.	0..1	CodeableConcept	High-level categorization (e.g. CTD Module 1, Clinical Trial Data) Binding: APIX CTD/eCTD Module Value Set (extensible): High-level kind of document at a macro level.
DocumentReference.subject	This element must be supported. This element is included in summaries.	0..1	Reference(Resource)	Used to link to specific products, such as a `MedicinalProductDefinition`
DocumentReference.context	C	0..*	Reference(Appointment \| Encounter \| EpisodeOfCare)	Context of the document content
DocumentReference.date	This element is included in summaries.	1..1	instant	Date/time this document reference was created
DocumentReference.relatesTo	This element must be supported. This element is included in summaries.	0..*	BackboneElement	Relationships to other documents
DocumentReference.relatesTo.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code	This element is included in summaries.	1..1	CodeableConcept	The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
DocumentReference.relatesTo.target	This element is included in summaries.	1..1	Reference(DocumentReference)	Target of the relationship
DocumentReference.description	This element must be supported. This element is included in summaries.	0..1	markdown	Human-readable summary of the document
DocumentReference.securityLabel	This element must be supported. This element is included in summaries.	0..*	CodeableConcept	Confidentiality/Security labels Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content	This element is included in summaries.	1..1	BackboneElement	Document content
DocumentReference.content.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment	This element is included in summaries.	1..1	Attachment	Attachment with document data
DocumentReference.content.attachment.contentType	This element is included in summaries. C	1..1	code	MIME type of the document Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png
DocumentReference.content.attachment.data	C	0..1	base64Binary	Embedded base64 content (optional in Index Pattern)
DocumentReference.content.attachment.url	This element is included in summaries.	1..1	url	Reference to document on FHIR server or external URL Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.size	This element must be supported. This element is included in summaries.	0..1	integer64	Size of the document in bytes
DocumentReference.content.attachment.hash	This element must be supported. This element is included in summaries.	0..1	base64Binary	Integrity check for the document content
DocumentReference.content.attachment.title	This element is included in summaries.	1..1	string	Human-readable title of the document Example General: Official Corporate Logo
DocumentReference.content.attachment.creation	This element is included in summaries.	1..1	dateTime	Date/time the document was created
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.identifier:docSetIdentifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
DocumentReference.identifier:docSetIdentifier.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
DocumentReference.identifier:docVersionNumberIdentifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
DocumentReference.identifier:docVersionNumberIdentifier.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
DocumentReference.status	Base	required	DocumentReferenceStatus	📍5.0.0	FHIR Std.
DocumentReference.docStatus	Base	required	Composition Status	📍5.0.0	FHIR Std.
DocumentReference.type	Base	example	Value Set APIX CTD/eCTD Section Code System	📦0.1.0	This IG
DocumentReference.category	Base	extensible	APIX CTD/eCTD Module Value Set	📦0.1.0	This IG
DocumentReference.relatesTo.code	Base	extensible	Document Relationship Type	📍5.0.0	FHIR Std.
DocumentReference.securityLabel	Base	example	Example set of Security Labels	📍5.0.0	FHIR Std.
DocumentReference.content.attachment.contentType	Base	required	Mime Types	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	DocumentReference	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().ofType(canonical) \| %resource.descendants().ofType(uri) \| %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	DocumentReference	A resource should have narrative for robust management	text.`div`.exists()
docRef-1	warning	DocumentReference	facilityType SHALL only be present if context is not an encounter	`facilityType.empty() or context.where(resolve() is Encounter).empty()`
docRef-2	warning	DocumentReference	practiceSetting SHALL only be present if context is not present	`practiceSetting.empty() or context.where(resolve() is Encounter).empty()`
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
identifier-is-a-uuid	error	DocumentReference.identifier:docSetIdentifier, DocumentReference.identifier:docVersionNumberIdentifier	Identifier value must be a urn:uuid	`value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')`

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
DocumentReference.Slices for identifier	This element must be supported.	2..2	Identifier	Document Set Identifier and Document Version Identifier Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:docSetIdentifier	This element must be supported. C	1..1	Identifier	Document Set Identifier Constraints: identifier-is-a-uuid
DocumentReference.Slices for identifier.identifier:docSetIdentifier.type		1..1	CodeableConcept	Description of identifier Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo", "code" : "docsetid", "display" : "Document Set Identifier" } ] }`
DocumentReference.Slices for identifier.identifier:docSetIdentifier.system		1..1	uri	The namespace for the identifier value
DocumentReference.Slices for identifier.identifier:docSetIdentifier.value		1..1	string	The value that is unique
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier	This element must be supported. C	1..1	Identifier	Document Version Number Identifier Constraints: identifier-is-a-uuid
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.type		1..1	CodeableConcept	Description of identifier Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo", "code" : "docverid", "display" : "Document Version Number Identifier" } ] }`
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.system		1..1	uri	The namespace for the identifier value
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.value		1..1	string	The value that is unique
DocumentReference.version	This element must be supported.	0..1	string	Business version of the document (e.g. 1.0, 2.1)
DocumentReference.status		1..1	code	current \| superseded \| entered-in-error
DocumentReference.docStatus	This element must be supported.	0..1	code	preliminary \| final \| amended \| appended
DocumentReference.type	This element must be supported.	1..1	CodeableConcept	CTD section code (e.g. 3.2.S.1.1) Binding: Value Set APIX CTD/eCTD Section Code System (example): Precise type of clinical document.
DocumentReference.category	This element must be supported.	0..1	CodeableConcept	High-level categorization (e.g. CTD Module 1, Clinical Trial Data) Binding: APIX CTD/eCTD Module Value Set (extensible): High-level kind of document at a macro level.
DocumentReference.subject	This element must be supported.	0..1	Reference(Resource)	Used to link to specific products, such as a `MedicinalProductDefinition`
DocumentReference.date		1..1	instant	Date/time this document reference was created
DocumentReference.relatesTo	This element must be supported.	0..*	BackboneElement	Relationships to other documents
DocumentReference.description	This element must be supported.	0..1	markdown	Human-readable summary of the document
DocumentReference.securityLabel	This element must be supported.	0..*	CodeableConcept	Confidentiality/Security labels
DocumentReference.content		1..1	BackboneElement	Document content
DocumentReference.content.attachment		1..1	Attachment	Attachment with document data
DocumentReference.content.attachment.contentType		1..1	code	MIME type of the document
DocumentReference.content.attachment.data		0..1	base64Binary	Embedded base64 content (optional in Index Pattern)
DocumentReference.content.attachment.url		1..1	url	Reference to document on FHIR server or external URL
DocumentReference.content.attachment.size	This element must be supported.	0..1	integer64	Size of the document in bytes
DocumentReference.content.attachment.hash	This element must be supported.	0..1	base64Binary	Integrity check for the document content
DocumentReference.content.attachment.title		1..1	string	Human-readable title of the document
DocumentReference.content.attachment.creation		1..1	dateTime	Date/time the document was created
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.type	Base	example	Value Set APIX CTD/eCTD Section Code System	📦0.1.0	This IG
DocumentReference.category	Base	extensible	APIX CTD/eCTD Module Value Set	📦0.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
identifier-is-a-uuid	error	DocumentReference.identifier:docSetIdentifier, DocumentReference.identifier:docVersionNumberIdentifier	Identifier value must be a urn:uuid	`value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')`

Description & Constraints Filter:

DocumentReference C 0..* DocumentReference A reference to a document
Constraints: docRef-1, docRef-2

DocumentReference.id This element is included in summaries. 0..1 id Logical id of this artifact

DocumentReference.meta This element is included in summaries. 0..1 Meta Metadata about the resource

DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created

language

0..1

code

Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional Bindings

Purpose

CommonLanguages

Starter

DocumentReference.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

DocumentReference.contained 0..* Resource Contained, inline Resources

DocumentReference.extension 0..* Extension Additional content defined by implementations

DocumentReference.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored

DocumentReference.Slices for identifier This element must be supported. This element is included in summaries. 2..2 Identifier Document Set Identifier and Document Version Identifier
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

DocumentReference.Slices for identifier.identifier:docSetIdentifier This element must be supported. This element is included in summaries. C 1..1 Identifier Document Set Identifier
Constraints: identifier-is-a-uuid

DocumentReference.Slices for identifier.identifier:docSetIdentifier.id 0..1 id Unique id for inter-element referencing

DocumentReference.Slices for identifier.identifier:docSetIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

DocumentReference.Slices for identifier.identifier:docSetIdentifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

type

1..1

CodeableConcept

Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "docsetid",
      "display" : "Document Set Identifier"
    }
  ]
}

DocumentReference.Slices for identifier.identifier:docSetIdentifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

DocumentReference.Slices for identifier.identifier:docSetIdentifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456

DocumentReference.Slices for identifier.identifier:docSetIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use

DocumentReference.Slices for identifier.identifier:docSetIdentifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier This element must be supported. This element is included in summaries. C 1..1 Identifier Document Version Number Identifier
Constraints: identifier-is-a-uuid

DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.id 0..1 id Unique id for inter-element referencing

DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

type

1..1

CodeableConcept

Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "docverid",
      "display" : "Document Version Number Identifier"
    }
  ]
}

DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456

DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use

DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

DocumentReference.version This element must be supported. This element is included in summaries. 0..1 string Business version of the document (e.g. 1.0, 2.1)

DocumentReference.status This element is a modifier element. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

DocumentReference.docStatus This element must be supported. This element is included in summaries. 0..1 code preliminary | final | amended | appended
Binding: CompositionStatus (required): Status of the underlying document.

DocumentReference.modality This element is included in summaries. 0..* CodeableConcept Imaging modality used
Binding: Modality (extensible): Type of acquired data in the instance.

DocumentReference.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept CTD section code (e.g. 3.2.S.1.1)
Binding: Value Set APIX CTD/eCTD Section Code System (example): Precise type of clinical document.

DocumentReference.category This element must be supported. This element is included in summaries. 0..1 CodeableConcept High-level categorization (e.g. CTD Module 1, Clinical Trial Data)
Binding: APIX CTD/eCTD Module Value Set (extensible): High-level kind of document at a macro level.

DocumentReference.subject This element must be supported. This element is included in summaries. 0..1 Reference(Resource) Used to link to specific products, such as a `MedicinalProductDefinition`

DocumentReference.context C 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content

DocumentReference.event 0..* CodeableReference() Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.

DocumentReference.bodySite This element is included in summaries. 0..* CodeableReference(BodyStructure) Body part included
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts

DocumentReference.facilityType C 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

DocumentReference.practiceSetting C 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).

DocumentReference.period This element is included in summaries. 0..1 Period Time of service that is being documented

DocumentReference.date This element is included in summaries. 1..1 instant Date/time this document reference was created

DocumentReference.attester 0..* BackboneElement Attests to accuracy of the document

DocumentReference.attester.id 0..1 string Unique id for inter-element referencing

DocumentReference.attester.extension 0..* Extension Additional content defined by implementations

DocumentReference.attester.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

DocumentReference.attester.mode 1..1 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.

DocumentReference.attester.time 0..1 dateTime When the document was attested

DocumentReference.attester.party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the document

DocumentReference.custodian 0..1 Reference(Organization) Organization which maintains the document

DocumentReference.relatesTo This element must be supported. This element is included in summaries. 0..* BackboneElement Relationships to other documents

DocumentReference.relatesTo.id 0..1 string Unique id for inter-element referencing

DocumentReference.relatesTo.extension 0..* Extension Additional content defined by implementations

DocumentReference.relatesTo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

DocumentReference.relatesTo.code This element is included in summaries. 1..1 CodeableConcept The relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.

DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship

DocumentReference.description This element must be supported. This element is included in summaries. 0..1 markdown Human-readable summary of the document

DocumentReference.securityLabel This element must be supported. This element is included in summaries. 0..* CodeableConcept Confidentiality/Security labels
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.

DocumentReference.content This element is included in summaries. 1..1 BackboneElement Document content

DocumentReference.content.id 0..1 string Unique id for inter-element referencing

DocumentReference.content.extension 0..* Extension Additional content defined by implementations

DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

DocumentReference.content.attachment This element is included in summaries. 1..1 Attachment Attachment with document data

DocumentReference.content.attachment.id 0..1 id Unique id for inter-element referencing

DocumentReference.content.attachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

DocumentReference.content.attachment.contentType This element is included in summaries. C 1..1 code MIME type of the document
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png

language

0..1

code

Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional Bindings

Purpose

CommonLanguages

Starter

Example General: en-AU

DocumentReference.content.attachment.data C 0..1 base64Binary Embedded base64 content (optional in Index Pattern)

DocumentReference.content.attachment.url This element is included in summaries. 1..1 url Reference to document on FHIR server or external URL
Example General: http://www.acme.com/logo-small.png

DocumentReference.content.attachment.size This element must be supported. This element is included in summaries. 0..1 integer64 Size of the document in bytes

DocumentReference.content.attachment.hash This element must be supported. This element is included in summaries. 0..1 base64Binary Integrity check for the document content

DocumentReference.content.attachment.title This element is included in summaries. 1..1 string Human-readable title of the document
Example General: Official Corporate Logo

DocumentReference.content.attachment.creation This element is included in summaries. 1..1 dateTime Date/time the document was created

DocumentReference.content.attachment.height 0..1 positiveInt Height of the image in pixels (photo/video)

DocumentReference.content.attachment.width 0..1 positiveInt Width of the image in pixels (photo/video)

DocumentReference.content.attachment.frames 0..1 positiveInt Number of frames if > 1 (photo)

DocumentReference.content.attachment.duration 0..1 decimal Length in seconds (audio / video)

DocumentReference.content.attachment.pages 0..1 positiveInt Number of printed pages

DocumentReference.content.profile This element is included in summaries. 0..* BackboneElement Content profile rules for the document

DocumentReference.content.profile.id 0..1 string Unique id for inter-element referencing

DocumentReference.content.profile.extension 0..* Extension Additional content defined by implementations

DocumentReference.content.profile.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

DocumentReference.content.profile.value[x] This element is included in summaries. 1..1 Code|uri|canonical
Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes.

DocumentReference.content.profile.value[x].valueCoding Coding

DocumentReference.content.profile.value[x].valueUri uri

DocumentReference.content.profile.value[x].valueCanonical canonical(Any)

Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.language	Base	required	All Languages	📍5.0.0	FHIR Std.
DocumentReference.identifier:docSetIdentifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
DocumentReference.identifier:docSetIdentifier.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
DocumentReference.identifier:docVersionNumberIdentifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
DocumentReference.identifier:docVersionNumberIdentifier.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
DocumentReference.status	Base	required	DocumentReferenceStatus	📍5.0.0	FHIR Std.
DocumentReference.docStatus	Base	required	Composition Status	📍5.0.0	FHIR Std.
DocumentReference.modality	Base	extensible	Modality	⏿2025.3.20250714	tx.fhir.org
DocumentReference.type	Base	example	Value Set APIX CTD/eCTD Section Code System	📦0.1.0	This IG
DocumentReference.category	Base	extensible	APIX CTD/eCTD Module Value Set	📦0.1.0	This IG
DocumentReference.event	Base	example	v3 Code System ActCode	📦3.0.0	THO v7.4
DocumentReference.bodySite	Base	example	SNOMED CT Body Structures	📍5.0.0	FHIR Std.
DocumentReference.facilityType	Base	example	Facility Type Code Value Set	📍5.0.0	FHIR Std.
DocumentReference.practiceSetting	Base	example	Practice Setting Code Value Set	📍5.0.0	FHIR Std.
DocumentReference.attester.mode	Base	preferred	Composition Attestation Mode	📍5.0.0	FHIR Std.
DocumentReference.relatesTo.code	Base	extensible	Document Relationship Type	📍5.0.0	FHIR Std.
DocumentReference.securityLabel	Base	example	Example set of Security Labels	📍5.0.0	FHIR Std.
DocumentReference.content.attachment.contentType	Base	required	Mime Types	📍5.0.0	FHIR Std.
DocumentReference.content.attachment.language	Base	required	All Languages	📍5.0.0	FHIR Std.
DocumentReference.content.profile.value[x]	Base	preferred	HL7 ValueSet of Format Codes for use with Document Sharing	📦2.1.0	THO v7.4

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	DocumentReference	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().ofType(canonical) \| %resource.descendants().ofType(uri) \| %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	DocumentReference	A resource should have narrative for robust management	text.`div`.exists()
docRef-1	warning	DocumentReference	facilityType SHALL only be present if context is not an encounter	`facilityType.empty() or context.where(resolve() is Encounter).empty()`
docRef-2	warning	DocumentReference	practiceSetting SHALL only be present if context is not present	`practiceSetting.empty() or context.where(resolve() is Encounter).empty()`
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
identifier-is-a-uuid	error	DocumentReference.identifier:docSetIdentifier, DocumentReference.identifier:docVersionNumberIdentifier	Identifier value must be a urn:uuid	`value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')`

This structure is derived from DocumentReference

Summary

Mandatory: 14 elements
Must-Support: 13 elements

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of DocumentReference.identifier

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
DocumentReference	C	0..*	DocumentReference	A reference to a document Constraints: docRef-1, docRef-2
DocumentReference.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
DocumentReference.contained		0..*	Resource	Contained, inline Resources
DocumentReference.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.Slices for identifier	This element must be supported. This element is included in summaries.	2..2	Identifier	Document Set Identifier and Document Version Identifier Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:docSetIdentifier	This element must be supported. This element is included in summaries. C	1..1	Identifier	Document Set Identifier Constraints: identifier-is-a-uuid
DocumentReference.Slices for identifier.identifier:docSetIdentifier.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DocumentReference.Slices for identifier.identifier:docSetIdentifier.type	This element is included in summaries.	1..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo", "code" : "docsetid", "display" : "Document Set Identifier" } ] }`
DocumentReference.Slices for identifier.identifier:docSetIdentifier.system	This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
DocumentReference.Slices for identifier.identifier:docSetIdentifier.value	This element is included in summaries. C	1..1	string	The value that is unique Example General: 123456
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier	This element must be supported. This element is included in summaries. C	1..1	Identifier	Document Version Number Identifier Constraints: identifier-is-a-uuid
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.type	This element is included in summaries.	1..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo", "code" : "docverid", "display" : "Document Version Number Identifier" } ] }`
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.system	This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.value	This element is included in summaries. C	1..1	string	The value that is unique Example General: 123456
DocumentReference.version	This element must be supported. This element is included in summaries.	0..1	string	Business version of the document (e.g. 1.0, 2.1)
DocumentReference.status	This element is a modifier element. This element is included in summaries.	1..1	code	current \| superseded \| entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
DocumentReference.docStatus	This element must be supported. This element is included in summaries.	0..1	code	preliminary \| final \| amended \| appended Binding: CompositionStatus (required): Status of the underlying document.
DocumentReference.type	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	CTD section code (e.g. 3.2.S.1.1) Binding: Value Set APIX CTD/eCTD Section Code System (example): Precise type of clinical document.
DocumentReference.category	This element must be supported. This element is included in summaries.	0..1	CodeableConcept	High-level categorization (e.g. CTD Module 1, Clinical Trial Data) Binding: APIX CTD/eCTD Module Value Set (extensible): High-level kind of document at a macro level.
DocumentReference.subject	This element must be supported. This element is included in summaries.	0..1	Reference(Resource)	Used to link to specific products, such as a `MedicinalProductDefinition`
DocumentReference.context	C	0..*	Reference(Appointment \| Encounter \| EpisodeOfCare)	Context of the document content
DocumentReference.date	This element is included in summaries.	1..1	instant	Date/time this document reference was created
DocumentReference.relatesTo	This element must be supported. This element is included in summaries.	0..*	BackboneElement	Relationships to other documents
DocumentReference.relatesTo.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code	This element is included in summaries.	1..1	CodeableConcept	The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
DocumentReference.relatesTo.target	This element is included in summaries.	1..1	Reference(DocumentReference)	Target of the relationship
DocumentReference.description	This element must be supported. This element is included in summaries.	0..1	markdown	Human-readable summary of the document
DocumentReference.securityLabel	This element must be supported. This element is included in summaries.	0..*	CodeableConcept	Confidentiality/Security labels Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content	This element is included in summaries.	1..1	BackboneElement	Document content
DocumentReference.content.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment	This element is included in summaries.	1..1	Attachment	Attachment with document data
DocumentReference.content.attachment.contentType	This element is included in summaries. C	1..1	code	MIME type of the document Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png
DocumentReference.content.attachment.data	C	0..1	base64Binary	Embedded base64 content (optional in Index Pattern)
DocumentReference.content.attachment.url	This element is included in summaries.	1..1	url	Reference to document on FHIR server or external URL Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.size	This element must be supported. This element is included in summaries.	0..1	integer64	Size of the document in bytes
DocumentReference.content.attachment.hash	This element must be supported. This element is included in summaries.	0..1	base64Binary	Integrity check for the document content
DocumentReference.content.attachment.title	This element is included in summaries.	1..1	string	Human-readable title of the document Example General: Official Corporate Logo
DocumentReference.content.attachment.creation	This element is included in summaries.	1..1	dateTime	Date/time the document was created
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.identifier:docSetIdentifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
DocumentReference.identifier:docSetIdentifier.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
DocumentReference.identifier:docVersionNumberIdentifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
DocumentReference.identifier:docVersionNumberIdentifier.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
DocumentReference.status	Base	required	DocumentReferenceStatus	📍5.0.0	FHIR Std.
DocumentReference.docStatus	Base	required	Composition Status	📍5.0.0	FHIR Std.
DocumentReference.type	Base	example	Value Set APIX CTD/eCTD Section Code System	📦0.1.0	This IG
DocumentReference.category	Base	extensible	APIX CTD/eCTD Module Value Set	📦0.1.0	This IG
DocumentReference.relatesTo.code	Base	extensible	Document Relationship Type	📍5.0.0	FHIR Std.
DocumentReference.securityLabel	Base	example	Example set of Security Labels	📍5.0.0	FHIR Std.
DocumentReference.content.attachment.contentType	Base	required	Mime Types	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	DocumentReference	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().ofType(canonical) \| %resource.descendants().ofType(uri) \| %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	DocumentReference	A resource should have narrative for robust management	text.`div`.exists()
docRef-1	warning	DocumentReference	facilityType SHALL only be present if context is not an encounter	`facilityType.empty() or context.where(resolve() is Encounter).empty()`
docRef-2	warning	DocumentReference	practiceSetting SHALL only be present if context is not present	`practiceSetting.empty() or context.where(resolve() is Encounter).empty()`
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
identifier-is-a-uuid	error	DocumentReference.identifier:docSetIdentifier, DocumentReference.identifier:docVersionNumberIdentifier	Identifier value must be a urn:uuid	`value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')`

Differential View

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
DocumentReference.Slices for identifier	This element must be supported.	2..2	Identifier	Document Set Identifier and Document Version Identifier Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:docSetIdentifier	This element must be supported. C	1..1	Identifier	Document Set Identifier Constraints: identifier-is-a-uuid
DocumentReference.Slices for identifier.identifier:docSetIdentifier.type		1..1	CodeableConcept	Description of identifier Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo", "code" : "docsetid", "display" : "Document Set Identifier" } ] }`
DocumentReference.Slices for identifier.identifier:docSetIdentifier.system		1..1	uri	The namespace for the identifier value
DocumentReference.Slices for identifier.identifier:docSetIdentifier.value		1..1	string	The value that is unique
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier	This element must be supported. C	1..1	Identifier	Document Version Number Identifier Constraints: identifier-is-a-uuid
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.type		1..1	CodeableConcept	Description of identifier Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo", "code" : "docverid", "display" : "Document Version Number Identifier" } ] }`
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.system		1..1	uri	The namespace for the identifier value
DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.value		1..1	string	The value that is unique
DocumentReference.version	This element must be supported.	0..1	string	Business version of the document (e.g. 1.0, 2.1)
DocumentReference.status		1..1	code	current \| superseded \| entered-in-error
DocumentReference.docStatus	This element must be supported.	0..1	code	preliminary \| final \| amended \| appended
DocumentReference.type	This element must be supported.	1..1	CodeableConcept	CTD section code (e.g. 3.2.S.1.1) Binding: Value Set APIX CTD/eCTD Section Code System (example): Precise type of clinical document.
DocumentReference.category	This element must be supported.	0..1	CodeableConcept	High-level categorization (e.g. CTD Module 1, Clinical Trial Data) Binding: APIX CTD/eCTD Module Value Set (extensible): High-level kind of document at a macro level.
DocumentReference.subject	This element must be supported.	0..1	Reference(Resource)	Used to link to specific products, such as a `MedicinalProductDefinition`
DocumentReference.date		1..1	instant	Date/time this document reference was created
DocumentReference.relatesTo	This element must be supported.	0..*	BackboneElement	Relationships to other documents
DocumentReference.description	This element must be supported.	0..1	markdown	Human-readable summary of the document
DocumentReference.securityLabel	This element must be supported.	0..*	CodeableConcept	Confidentiality/Security labels
DocumentReference.content		1..1	BackboneElement	Document content
DocumentReference.content.attachment		1..1	Attachment	Attachment with document data
DocumentReference.content.attachment.contentType		1..1	code	MIME type of the document
DocumentReference.content.attachment.data		0..1	base64Binary	Embedded base64 content (optional in Index Pattern)
DocumentReference.content.attachment.url		1..1	url	Reference to document on FHIR server or external URL
DocumentReference.content.attachment.size	This element must be supported.	0..1	integer64	Size of the document in bytes
DocumentReference.content.attachment.hash	This element must be supported.	0..1	base64Binary	Integrity check for the document content
DocumentReference.content.attachment.title		1..1	string	Human-readable title of the document
DocumentReference.content.attachment.creation		1..1	dateTime	Date/time the document was created
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.type	Base	example	Value Set APIX CTD/eCTD Section Code System	📦0.1.0	This IG
DocumentReference.category	Base	extensible	APIX CTD/eCTD Module Value Set	📦0.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
identifier-is-a-uuid	error	DocumentReference.identifier:docSetIdentifier, DocumentReference.identifier:docVersionNumberIdentifier	Identifier value must be a urn:uuid	`value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')`

Snapshot ViewView

Description & Constraints Filter:

DocumentReference C 0..* DocumentReference A reference to a document
Constraints: docRef-1, docRef-2

DocumentReference.id This element is included in summaries. 0..1 id Logical id of this artifact

DocumentReference.meta This element is included in summaries. 0..1 Meta Metadata about the resource

DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created

language

0..1

code

Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional Bindings

Purpose

CommonLanguages

Starter

DocumentReference.contained 0..* Resource Contained, inline Resources

DocumentReference.extension 0..* Extension Additional content defined by implementations

DocumentReference.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored

DocumentReference.Slices for identifier.identifier:docSetIdentifier.id 0..1 id Unique id for inter-element referencing

DocumentReference.Slices for identifier.identifier:docSetIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

type

1..1

CodeableConcept

Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "docsetid",
      "display" : "Document Set Identifier"
    }
  ]
}

DocumentReference.Slices for identifier.identifier:docSetIdentifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456

DocumentReference.Slices for identifier.identifier:docSetIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use

DocumentReference.Slices for identifier.identifier:docSetIdentifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.id 0..1 id Unique id for inter-element referencing

DocumentReference.Slices for identifier.identifier:docVersionNumberIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

type

1..1

CodeableConcept

Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "docverid",
      "display" : "Document Version Number Identifier"
    }
  ]
}