Guide d’Implémentation FHIR – Pré-admission Hospitalière en Ligne
0.1.0 - ci-build
FRANCE
Guide d’Implémentation FHIR – Pré-admission Hospitalière en Ligne - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.fr/fhir/fr/preadmission/StructureDefinition/preadmission-documentreference-fr | Version: 0.1.0 | |||
| Draft as of 2026-02-24 | Computable Name: PreadmissionDocumentReferenceFr | |||
Profil DocumentReference pour un document administratif de préadmission
Dans le cadre de la préadmission hospitalière, le patient est invité à fournir certains documents administratifs nécessaires à la validation de son dossier. Ces documents permettent à l’établissement de santé de vérifier l’identité, la couverture sociale du patient avant son admission.
Les documents sont modélisés dans FHIR à l’aide de la ressource DocumentReference, enrichie d’extensions spécifiques pour répondre aux besoins du processus de préadmission.
Ces documents sont modélisés dans FHIR à l’aide de la ressource DocumentReference, avec le type de document contraint par le ValueSet PreadmissionValueSetDocumentTypeFr.
DocumentReferenceLa ressource DocumentReference est utilisée pour représenter chaque document transmis par le patient. Elle contient des métadonnées essentielles telles que le type de document, la date de création, et un lien vers le fichier téléversé.
PreadmissionTypeDocumentFr.Encounter via DocumentReference.context.encounter.Dans le contexte de la préadmission, la ressource DocumentReference ne peut être recherchée qu’à partir de lencounter. Cela signifie que les systèmes doivent utiliser uniquement le critère encounter pour récupérer les documents liés à la pré-admission, conformément aux contraintes d’implémentation définies.
documentreference?encounter=
La ressource DocumentReference joue un rôle clé dans la gestion des pièces justificatives pour la préadmission hospitalière. Elle garantit une organisation structurée et conforme des documents, tout en facilitant leur traitement par les agents administratifs.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Nom | Drapeaux | Card. | Type | Description et contraintes Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: preadmission-document-type-vs (required) |
![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() |
Σ | 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. Exemple General: text/plain; charset=UTF-8, image/png |
![]() ![]() |
Σ | 1..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | Reference(Fr Preadmission Encounter Profile) | Context of the document content | |
Documentation for this format | ||||
| Path | Conformité | ValueSet | URI |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1From the FHIR Standard | |
| DocumentReference.type | required | PreadmissionDocumentTypeFrValueSethttp://hl7.fr/fhir/fr/preadmission/ValueSet/preadmission-document-type-vsFrom this IG | |
| 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 |
| Id | Grade | Path(s) | Détails | Requirements |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() | |
| 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() |
This structure is derived from DocumentReference
| Nom | Drapeaux | Card. | Type | Description et contraintes Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() |
1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: preadmission-document-type-vs (required) | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. | |
![]() ![]() |
1..1 | BackboneElement | Clinical context of document | |
![]() ![]() ![]() |
1..1 | Reference(Fr Preadmission Encounter Profile) | Context of the document content | |
Documentation for this format | ||||
| Path | Conformité | ValueSet | URI |
| DocumentReference.type | required | PreadmissionDocumentTypeFrValueSethttp://hl7.fr/fhir/fr/preadmission/ValueSet/preadmission-document-type-vsFrom this IG |
| Nom | Drapeaux | Card. | Type | Description et contraintes Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: preadmission-document-type-vs (required) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document | ||||
![]() ![]() |
Σ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 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. Exemple General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Exemple General: en-AU | ||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Exemple General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Exemple General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
![]() ![]() |
Σ | 1..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(Fr Preadmission Encounter Profile) | Context of the document content | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
Documentation for this format | ||||||||
| Path | Conformité | 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 | required | PreadmissionDocumentTypeFrValueSethttp://hl7.fr/fhir/fr/preadmission/ValueSet/preadmission-document-type-vsFrom this IG | ||||
| DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | ||||
| 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 |
| Id | Grade | Path(s) | Détails | Requirements |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() | |
| 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() |
This structure is derived from DocumentReference
Key Elements View
| Nom | Drapeaux | Card. | Type | Description et contraintes Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: preadmission-document-type-vs (required) |
![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() |
Σ | 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. Exemple General: text/plain; charset=UTF-8, image/png |
![]() ![]() |
Σ | 1..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | Reference(Fr Preadmission Encounter Profile) | Context of the document content | |
Documentation for this format | ||||
| Path | Conformité | ValueSet | URI |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1From the FHIR Standard | |
| DocumentReference.type | required | PreadmissionDocumentTypeFrValueSethttp://hl7.fr/fhir/fr/preadmission/ValueSet/preadmission-document-type-vsFrom this IG | |
| 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 |
| Id | Grade | Path(s) | Détails | Requirements |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() | |
| 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() |
Differential View
This structure is derived from DocumentReference
| Nom | Drapeaux | Card. | Type | Description et contraintes Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() |
1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: preadmission-document-type-vs (required) | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. | |
![]() ![]() |
1..1 | BackboneElement | Clinical context of document | |
![]() ![]() ![]() |
1..1 | Reference(Fr Preadmission Encounter Profile) | Context of the document content | |
Documentation for this format | ||||
| Path | Conformité | ValueSet | URI |
| DocumentReference.type | required | PreadmissionDocumentTypeFrValueSethttp://hl7.fr/fhir/fr/preadmission/ValueSet/preadmission-document-type-vsFrom this IG |
Snapshot View
| Nom | Drapeaux | Card. | Type | Description et contraintes Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: preadmission-document-type-vs (required) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document | ||||
![]() ![]() |
Σ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 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. Exemple General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Exemple General: en-AU | ||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Exemple General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Exemple General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
![]() ![]() |
Σ | 1..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(Fr Preadmission Encounter Profile) | Context of the document content | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
Documentation for this format | ||||||||
| Path | Conformité | 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 | required | PreadmissionDocumentTypeFrValueSethttp://hl7.fr/fhir/fr/preadmission/ValueSet/preadmission-document-type-vsFrom this IG | ||||
| DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | ||||
| 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 |
| Id | Grade | Path(s) | Détails | Requirements |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() | |
| 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() |
This structure is derived from DocumentReference
Other representations of profile: CSV, Excel, Schematron