Search FHIR

Médicosocial - Suivi Décisions Orientation
4.0.3 - trial-use France flag

This page is part of the Médicosocial - Suivi Décisions Orientation (v4.0.3: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: ESMSDocumentReference

Official URL: https://interop.esante.gouv.fr/ig/fhir/sdo/StructureDefinition/esms-document-reference Version: 4.0.3
Active as of 2025-01-30 Computable Name: ESMSDocumentReference

Profil ESMS héritant du profil SDODocumentReference. Profil utilisé pour véhiculer les données de l’individu et de la décision, ou les données de l’évaluation dans un document CDA

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* SDODocumentReference 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
regle-Contenu: Le transport des données devient obligatoire lorsque la ressource complète est transportée, le champs data doit alors être rempli
regle-NomPieceJointe-type: La combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
... 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
... Slices for identifier Σ 2..2 Identifier identifiants métier (idDecision) et technique (idNat_decision) de la décision d'orientation
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:idDecision Σ 1..1 Identifier Other identifiers for the document
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: usual
..... value Σ 1..1 string identifiant de la décision unique au sein de la MDPH ayant créé la décision (idDecision)
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:idNat_Decision Σ 0..1 Identifier Other identifiers for the document
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: official
..... value Σ 1..1 string identifiant technique national de la décision, généré par le SI-SDO (idNat_Decision)
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... type Σ 1..1 CodeableConcept Code identifiant le type de document CDA véhiculé dans la ressource (Individu et Décision ou Evaluation)
Binding: DocumentReferenceTypeESMSValueSet (required)
ele-1: All FHIR elements must have a @value or children
.... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
... content Σ 1..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
..... title Σ 1..1 string Titre identifiant le contenu du document transporté.
ele-1: All FHIR elements must have a @value or children
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.identifier:idDecision.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier:idNat_Decision.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typerequiredDocumentReferenceTypeESMSValueSet
https://interop.esante.gouv.fr/ig/fhir/sdo/ValueSet/type-document-reference-esms-valueset
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
regle-ContenuwarningDocumentReferenceLe transport des données devient obligatoire lorsque la ressource complète est transportée, le champs data doit alors être rempli
: content.attachment.data.exists()
regle-NomPieceJointe-typeerrorDocumentReferenceLa combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
: (type.coding.where(code='57830-2').exists() implies (content.attachment.where(title='Document Individu et décision')).exists()) and (type.coding.where(code='51848-0').exists() implies (content.attachment.where(title='Document évaluation')).exists())

This structure is derived from SDODocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* SDODocumentReference A reference to a document
regle-NomPieceJointe-type: La combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
... identifier 2..2 Identifier identifiants métier (idDecision) et technique (idNat_decision) de la décision d'orientation
... type 1..1 CodeableConcept Code identifiant le type de document CDA véhiculé dans la ressource (Individu et Décision ou Evaluation)
Binding: DocumentReferenceTypeESMSValueSet (required)
.... coding 1..1 Coding Code defined by a terminology system
... content
.... attachment
..... title 1..1 string Titre identifiant le contenu du document transporté.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.typerequiredDocumentReferenceTypeESMSValueSet
https://interop.esante.gouv.fr/ig/fhir/sdo/ValueSet/type-document-reference-esms-valueset
from this IG

Constraints

IdGradePath(s)DetailsRequirements
regle-NomPieceJointe-typeerrorDocumentReferenceLa combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
: (type.coding.where(code='57830-2').exists() implies (content.attachment.where(title='Document Individu et décision')).exists()) and (type.coding.where(code='51848-0').exists() implies (content.attachment.where(title='Document évaluation')).exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* SDODocumentReference A reference to a document
regle-Contenu: Le transport des données devient obligatoire lorsque la ressource complète est transportée, le champs data doit alors être rempli
regle-NomPieceJointe-type: La combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
... id Σ 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
... 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
... Slices for identifier Σ 2..2 Identifier identifiants métier (idDecision) et technique (idNat_decision) de la décision d'orientation
Slice: Unordered, Open by value:use
.... identifier:idDecision Σ 1..1 Identifier Other identifiers for 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
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string identifiant de la décision unique au sein de la MDPH ayant créé la décision (idDecision)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:idNat_Decision Σ 0..1 Identifier Other identifiers for 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
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string identifiant technique national de la décision, généré par le SI-SDO (idNat_Decision)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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 Code identifiant le type de document CDA véhiculé dans la ressource (Individu et Décision ou Evaluation)
Binding: DocumentReferenceTypeESMSValueSet (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Who/what is the subject of the document
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* 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 Σ 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 Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content Σ 1..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 Σ 0..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 Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 1..1 string Titre identifiant le contenu du document transporté.
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..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
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... 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 Σ 0..1 Period Time of service that is being documented
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

.... practiceSetting 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).

.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.identifier:idDecision.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier:idDecision.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DocumentReference.identifier:idNat_Decision.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier:idNat_Decision.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typerequiredDocumentReferenceTypeESMSValueSet
https://interop.esante.gouv.fr/ig/fhir/sdo/ValueSet/type-document-reference-esms-valueset
from this IG
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
regle-ContenuwarningDocumentReferenceLe transport des données devient obligatoire lorsque la ressource complète est transportée, le champs data doit alors être rempli
: content.attachment.data.exists()
regle-NomPieceJointe-typeerrorDocumentReferenceLa combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
: (type.coding.where(code='57830-2').exists() implies (content.attachment.where(title='Document Individu et décision')).exists()) and (type.coding.where(code='51848-0').exists() implies (content.attachment.where(title='Document évaluation')).exists())

This structure is derived from SDODocumentReference

Summary

Mandatory: 2 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* SDODocumentReference 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
regle-Contenu: Le transport des données devient obligatoire lorsque la ressource complète est transportée, le champs data doit alors être rempli
regle-NomPieceJointe-type: La combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
... 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
... Slices for identifier Σ 2..2 Identifier identifiants métier (idDecision) et technique (idNat_decision) de la décision d'orientation
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:idDecision Σ 1..1 Identifier Other identifiers for the document
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: usual
..... value Σ 1..1 string identifiant de la décision unique au sein de la MDPH ayant créé la décision (idDecision)
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:idNat_Decision Σ 0..1 Identifier Other identifiers for the document
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: official
..... value Σ 1..1 string identifiant technique national de la décision, généré par le SI-SDO (idNat_Decision)
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... type Σ 1..1 CodeableConcept Code identifiant le type de document CDA véhiculé dans la ressource (Individu et Décision ou Evaluation)
Binding: DocumentReferenceTypeESMSValueSet (required)
ele-1: All FHIR elements must have a @value or children
.... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
... content Σ 1..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
..... title Σ 1..1 string Titre identifiant le contenu du document transporté.
ele-1: All FHIR elements must have a @value or children
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.identifier:idDecision.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier:idNat_Decision.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typerequiredDocumentReferenceTypeESMSValueSet
https://interop.esante.gouv.fr/ig/fhir/sdo/ValueSet/type-document-reference-esms-valueset
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
regle-ContenuwarningDocumentReferenceLe transport des données devient obligatoire lorsque la ressource complète est transportée, le champs data doit alors être rempli
: content.attachment.data.exists()
regle-NomPieceJointe-typeerrorDocumentReferenceLa combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
: (type.coding.where(code='57830-2').exists() implies (content.attachment.where(title='Document Individu et décision')).exists()) and (type.coding.where(code='51848-0').exists() implies (content.attachment.where(title='Document évaluation')).exists())

Differential View

This structure is derived from SDODocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* SDODocumentReference A reference to a document
regle-NomPieceJointe-type: La combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
... identifier 2..2 Identifier identifiants métier (idDecision) et technique (idNat_decision) de la décision d'orientation
... type 1..1 CodeableConcept Code identifiant le type de document CDA véhiculé dans la ressource (Individu et Décision ou Evaluation)
Binding: DocumentReferenceTypeESMSValueSet (required)
.... coding 1..1 Coding Code defined by a terminology system
... content
.... attachment
..... title 1..1 string Titre identifiant le contenu du document transporté.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.typerequiredDocumentReferenceTypeESMSValueSet
https://interop.esante.gouv.fr/ig/fhir/sdo/ValueSet/type-document-reference-esms-valueset
from this IG

Constraints

IdGradePath(s)DetailsRequirements
regle-NomPieceJointe-typeerrorDocumentReferenceLa combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
: (type.coding.where(code='57830-2').exists() implies (content.attachment.where(title='Document Individu et décision')).exists()) and (type.coding.where(code='51848-0').exists() implies (content.attachment.where(title='Document évaluation')).exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* SDODocumentReference A reference to a document
regle-Contenu: Le transport des données devient obligatoire lorsque la ressource complète est transportée, le champs data doit alors être rempli
regle-NomPieceJointe-type: La combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
... id Σ 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
... 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
... Slices for identifier Σ 2..2 Identifier identifiants métier (idDecision) et technique (idNat_decision) de la décision d'orientation
Slice: Unordered, Open by value:use
.... identifier:idDecision Σ 1..1 Identifier Other identifiers for 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
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string identifiant de la décision unique au sein de la MDPH ayant créé la décision (idDecision)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:idNat_Decision Σ 0..1 Identifier Other identifiers for 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
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string identifiant technique national de la décision, généré par le SI-SDO (idNat_Decision)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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 Code identifiant le type de document CDA véhiculé dans la ressource (Individu et Décision ou Evaluation)
Binding: DocumentReferenceTypeESMSValueSet (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Who/what is the subject of the document
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* 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 Σ 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 Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content Σ 1..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 Σ 0..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 Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 1..1 string Titre identifiant le contenu du document transporté.
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..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
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... 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 Σ 0..1 Period Time of service that is being documented
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

.... practiceSetting 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).

.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.identifier:idDecision.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier:idDecision.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DocumentReference.identifier:idNat_Decision.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier:idNat_Decision.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typerequiredDocumentReferenceTypeESMSValueSet
https://interop.esante.gouv.fr/ig/fhir/sdo/ValueSet/type-document-reference-esms-valueset
from this IG
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
regle-ContenuwarningDocumentReferenceLe transport des données devient obligatoire lorsque la ressource complète est transportée, le champs data doit alors être rempli
: content.attachment.data.exists()
regle-NomPieceJointe-typeerrorDocumentReferenceLa combinaison entre le code du documentRefenrece et le nom de la pièce jointe doit être : titre ="Document Individu et décision" et code = "57830-2"ou titre ="Document évaluation" et code = "51848-0"
: (type.coding.where(code='57830-2').exists() implies (content.attachment.where(title='Document Individu et décision')).exists()) and (type.coding.where(code='51848-0').exists() implies (content.attachment.where(title='Document évaluation')).exists())

This structure is derived from SDODocumentReference

Summary

Mandatory: 2 elements

 

Other representations of profile: CSV, Excel, Schematron