Non-patient File Sharing (NPFS)
2.2.1-current - ci-build
Non-patient File Sharing (NPFS)
2.2.1-current - ci-build
Non-patient File Sharing (NPFS), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 2.2.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.NPFS/ and changes regularly. See the Directory of published versions
| Official URL: https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReference | Version: 2.2.1-current | |||
| Active as of 2025-04-28 | Computable Name: NPFSDocumentReference | |||
A profile on the DocumentReference resource for NPFS.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DocumentReference |
DocumentReference | |||
  id |
S | 0..1 | id | Logical id of this artifact |
 identifier |
S | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use |
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible) | |
| category |
1..1 | CodeableConcept | Categorization of document Binding: NPFS DocumentReference category (extensible) | |
| subject |
0..0 | |||
| date |
1..1 | instant | When this document reference was created | |
| author |
1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | |
| relatesTo |
S | 0..* | BackboneElement | Relationships to other documents |
| securityLabel |
S | 0..* | CodeableConcept | Document security-tags |
| content |
||||
 attachment |
||||
| contentType |
1..1 | code | Mime type of the content, with charset etc. | |
| language |
S | 0..1 | code | Required if known |
| data |
0..0 | |||
| url |
1..1 | url | Uri where the data can be found | |
| size |
1..1 | unsignedInt | Number of bytes of content (if url provided) | |
| hash |
1..1 | base64Binary | Hash of the data (sha-1, base64ed) | |
 creation |
S | 0..1 | dateTime | Date attachment was first created |
| format |
S | 1..1 | Coding | Format/content rules for the document |
| context |
||||
 encounter |
0..0 | |||
| period |
S | 0..1 | Period | Time of service that is being documented |
| facilityType |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen |
| practiceSetting |
S | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) |
| sourcePatientInfo |
0..0 | |||
| related |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.category | extensible | DocumentReferenceCategoryhttps://profiles.ihe.net/ITI/NPFS/ValueSet/DocumentReferenceCategoryfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
 id |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| identifier |
SΣ | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children | ||||
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children | ||||
 type |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. ele-1: All FHIR elements must have a @value or children | ||||
| category |
Σ | 1..1 | CodeableConcept | Categorization of document Binding: NPFS DocumentReference category (extensible) ele-1: All FHIR elements must have a @value or children | ||||
| date |
Σ | 1..1 | instant | When this document reference was created ele-1: All FHIR elements must have a @value or children | ||||
 author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document ele-1: All FHIR elements must have a @value or children | ||||
| relatesTo |
SΣ | 0..* | BackboneElement | Relationships to other documents ele-1: All FHIR elements must have a @value or children | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| code |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children | ||||
| target |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship ele-1: All FHIR elements must have a @value or children | ||||
| securityLabel |
SΣ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children | ||||
| content |
Σ | 1..* | BackboneElement | Document referenced ele-1: All FHIR elements must have a @value or children | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| attachment |
Σ | 1..1 | Attachment | Where to access the document ele-1: All FHIR elements must have a @value or children | ||||
| contentType |
Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png | ||||
| language |
SΣ | 0..1 | code | Required if known Binding: CommonLanguages (preferred): A human language.
ele-1: All FHIR elements must have a @value or children Example General: en-AU | ||||
| url |
Σ | 1..1 | url | Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 1..1 | unsignedInt | Number of bytes of content (if url provided) ele-1: All FHIR elements must have a @value or children | ||||
| hash |
Σ | 1..1 | base64Binary | Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children | ||||
| creation |
SΣ | 0..1 | dateTime | Date attachment was first created ele-1: All FHIR elements must have a @value or children | ||||
| format |
SΣ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. ele-1: All FHIR elements must have a @value or children | ||||
| context |
Σ | 0..1 | BackboneElement | Clinical context of document ele-1: All FHIR elements must have a @value or children | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| period |
SΣ | 0..1 | Period | Time of service that is being documented ele-1: All FHIR elements must have a @value or children | ||||
| facilityType |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. ele-1: All FHIR elements must have a @value or children | ||||
| practiceSetting |
S | 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). ele-1: All FHIR elements must have a @value or children | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.type | preferred | DocumentTypeValueSethttp://hl7.org/fhir/ValueSet/c80-doc-typecodesfrom the FHIR Standard | ||||
| DocumentReference.category | extensible | DocumentReferenceCategoryhttps://profiles.ihe.net/ITI/NPFS/ValueSet/DocumentReferenceCategoryfrom this IG | ||||
| DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)http://hl7.org/fhir/ValueSet/formatcodesfrom the FHIR Standard | ||||
| DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodesfrom the FHIR Standard | ||||
| DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| masterIdentifier |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
| identifier |
SΣ | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use | ||||
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
| docStatus |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
| type |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. | ||||
| category |
Σ | 1..1 | CodeableConcept | Categorization of document Binding: NPFS DocumentReference category (extensible) | ||||
| date |
Σ | 1..1 | instant | When this document reference was created | ||||
| author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
| authenticator |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
| custodian |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
| relatesTo |
SΣ | 0..* | BackboneElement | Relationships to other documents | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
| target |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
| description |
Σ | 0..1 | string | Human-readable description | ||||
| securityLabel |
SΣ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| content |
Σ | 1..* | BackboneElement | Document referenced | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| attachment |
Σ | 1..1 | Attachment | Where to access the document | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language |
SΣ | 0..1 | code | Required if known Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| url |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 1..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash |
Σ | 1..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation |
SΣ | 0..1 | dateTime | Date attachment was first created | ||||
| format |
SΣ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
| context |
Σ | 0..1 | BackboneElement | Clinical context of document | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
| period |
SΣ | 0..1 | Period | Time of service that is being documented | ||||
| facilityType |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
| practiceSetting |
S | 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). | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.type | preferred | DocumentTypeValueSethttp://hl7.org/fhir/ValueSet/c80-doc-typecodesfrom the FHIR Standard | ||||
| DocumentReference.category | extensible | DocumentReferenceCategoryhttps://profiles.ihe.net/ITI/NPFS/ValueSet/DocumentReferenceCategoryfrom this IG | ||||
| DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)http://hl7.org/fhir/ValueSet/formatcodesfrom the FHIR Standard | ||||
| DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodesfrom the FHIR Standard | ||||
| DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard |
This structure is derived from DocumentReference
Summary
Mandatory: 9 elements
Must-Support: 10 elements
Prohibited: 5 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentReference |
DocumentReference | |||
| id |
S | 0..1 | id | Logical id of this artifact |
| identifier |
S | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use |
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible) | |
| category |
1..1 | CodeableConcept | Categorization of document Binding: NPFS DocumentReference category (extensible) | |
| subject |
0..0 | |||
| date |
1..1 | instant | When this document reference was created | |
| author |
1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | |
| relatesTo |
S | 0..* | BackboneElement | Relationships to other documents |
| securityLabel |
S | 0..* | CodeableConcept | Document security-tags |
| content |
||||
| attachment |
||||
| contentType |
1..1 | code | Mime type of the content, with charset etc. | |
| language |
S | 0..1 | code | Required if known |
| data |
0..0 | |||
| url |
1..1 | url | Uri where the data can be found | |
| size |
1..1 | unsignedInt | Number of bytes of content (if url provided) | |
| hash |
1..1 | base64Binary | Hash of the data (sha-1, base64ed) | |
| creation |
S | 0..1 | dateTime | Date attachment was first created |
| format |
S | 1..1 | Coding | Format/content rules for the document |
| context |
||||
| encounter |
0..0 | |||
| period |
S | 0..1 | Period | Time of service that is being documented |
| facilityType |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen |
| practiceSetting |
S | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) |
| sourcePatientInfo |
0..0 | |||
| related |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.category | extensible | DocumentReferenceCategoryhttps://profiles.ihe.net/ITI/NPFS/ValueSet/DocumentReferenceCategoryfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| identifier |
SΣ | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children | ||||
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children | ||||
| type |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. ele-1: All FHIR elements must have a @value or children | ||||
| category |
Σ | 1..1 | CodeableConcept | Categorization of document Binding: NPFS DocumentReference category (extensible) ele-1: All FHIR elements must have a @value or children | ||||
| date |
Σ | 1..1 | instant | When this document reference was created ele-1: All FHIR elements must have a @value or children | ||||
| author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document ele-1: All FHIR elements must have a @value or children | ||||
| relatesTo |
SΣ | 0..* | BackboneElement | Relationships to other documents ele-1: All FHIR elements must have a @value or children | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| code |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children | ||||
| target |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship ele-1: All FHIR elements must have a @value or children | ||||
| securityLabel |
SΣ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children | ||||
| content |
Σ | 1..* | BackboneElement | Document referenced ele-1: All FHIR elements must have a @value or children | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| attachment |
Σ | 1..1 | Attachment | Where to access the document ele-1: All FHIR elements must have a @value or children | ||||
| contentType |
Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png | ||||
| language |
SΣ | 0..1 | code | Required if known Binding: CommonLanguages (preferred): A human language.
ele-1: All FHIR elements must have a @value or children Example General: en-AU | ||||
| url |
Σ | 1..1 | url | Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 1..1 | unsignedInt | Number of bytes of content (if url provided) ele-1: All FHIR elements must have a @value or children | ||||
| hash |
Σ | 1..1 | base64Binary | Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children | ||||
| creation |
SΣ | 0..1 | dateTime | Date attachment was first created ele-1: All FHIR elements must have a @value or children | ||||
| format |
SΣ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. ele-1: All FHIR elements must have a @value or children | ||||
| context |
Σ | 0..1 | BackboneElement | Clinical context of document ele-1: All FHIR elements must have a @value or children | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| period |
SΣ | 0..1 | Period | Time of service that is being documented ele-1: All FHIR elements must have a @value or children | ||||
| facilityType |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. ele-1: All FHIR elements must have a @value or children | ||||
| practiceSetting |
S | 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). ele-1: All FHIR elements must have a @value or children | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.type | preferred | DocumentTypeValueSethttp://hl7.org/fhir/ValueSet/c80-doc-typecodesfrom the FHIR Standard | ||||
| DocumentReference.category | extensible | DocumentReferenceCategoryhttps://profiles.ihe.net/ITI/NPFS/ValueSet/DocumentReferenceCategoryfrom this IG | ||||
| DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)http://hl7.org/fhir/ValueSet/formatcodesfrom the FHIR Standard | ||||
| DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodesfrom the FHIR Standard | ||||
| DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| masterIdentifier |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
| identifier |
SΣ | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use | ||||
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
| docStatus |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
| type |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. | ||||
| category |
Σ | 1..1 | CodeableConcept | Categorization of document Binding: NPFS DocumentReference category (extensible) | ||||
| date |
Σ | 1..1 | instant | When this document reference was created | ||||
| author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
| authenticator |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
| custodian |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
| relatesTo |
SΣ | 0..* | BackboneElement | Relationships to other documents | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
| target |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
| description |
Σ | 0..1 | string | Human-readable description | ||||
| securityLabel |
SΣ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| content |
Σ | 1..* | BackboneElement | Document referenced | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| attachment |
Σ | 1..1 | Attachment | Where to access the document | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language |
SΣ | 0..1 | code | Required if known Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| url |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 1..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash |
Σ | 1..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation |
SΣ | 0..1 | dateTime | Date attachment was first created | ||||
| format |
SΣ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
| context |
Σ | 0..1 | BackboneElement | Clinical context of document | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
| period |
SΣ | 0..1 | Period | Time of service that is being documented | ||||
| facilityType |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
| practiceSetting |
S | 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). | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.type | preferred | DocumentTypeValueSethttp://hl7.org/fhir/ValueSet/c80-doc-typecodesfrom the FHIR Standard | ||||
| DocumentReference.category | extensible | DocumentReferenceCategoryhttps://profiles.ihe.net/ITI/NPFS/ValueSet/DocumentReferenceCategoryfrom this IG | ||||
| DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)http://hl7.org/fhir/ValueSet/formatcodesfrom the FHIR Standard | ||||
| DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodesfrom the FHIR Standard | ||||
| DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard |
This structure is derived from DocumentReference
Summary
Mandatory: 9 elements
Must-Support: 10 elements
Prohibited: 5 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ IHE IT Infrastructure Technical Committee. Package ihe.iti.npfs#2.2.1-current based on FHIR 4.0.1. Generated 2025-04-28
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change